io.whitfin.dottie.segment

Class NotationSegment<T>

java.lang.Object

io.whitfin.dottie.segment.NotationSegment<T>

Type Parameters:

T - the type of the notation.

Direct Known Subclasses:

NotationAccessor, NotationIndex, NotationProperty

public abstract class NotationSegment<T>
extends Object

Parent segment to be used to represent notation values of various types.

Property Summary

Type	Property and Description
NotationSegment<String>	as Returns this instance cast as a property segment.
boolean	is Gets the value of the property property.

Method Summary

Modifier and Type	Method and Description
NotationSegment<Integer>	asIndex() Returns this instance cast as an index segment.
NotationSegment<String>	asProperty() Returns this instance cast as a property segment.
abstract String	escape() Escapes the value for a joiner.
boolean	isIndex() Returns whether this instance is an index segment.
boolean	isProperty() Gets the value of the property property.
static NotationSegment	parse(Integer index) Parses an integer value into an index segment.
static NotationSegment	parse(String property) Parses a textual value into an property segment.
Class<T>	type() Returns the type of this instance.
T	value() Returns the generic value of this segment.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Property Detail

as

@Nonnull
public NotationSegment<String> asProperty

Returns this instance cast as a property segment.

is

public boolean isProperty

Gets the value of the property property.

Method Detail

escape

@Nonnull
public abstract String escape()

Escapes the value for a joiner.

Returns:

an escaped value.

asIndex

@Nonnull
public NotationSegment<Integer> asIndex()

Returns this instance cast as an index segment.

Returns:

this instance cast to an index segment.

asProperty

@Nonnull
public NotationSegment<String> asProperty()

Returns this instance cast as a property segment.

isIndex

public boolean isIndex()

Returns whether this instance is an index segment.

Returns:

true if an index segment.

isProperty

public boolean isProperty()

Gets the value of the property property.

type

@Nonnull
public Class<T> type()

Returns the type of this instance. This can be used to determine whether this is an index or property segment instance.

Returns:

the class type of this segment.

value

@Nonnull
public T value()

Returns the generic value of this segment.

Returns:

the internal value.

parse

@Nonnull
public static NotationSegment parse(@Nonnull
                                             Integer index)

Parses an integer value into an index segment.

Parameters:

index - the index to parse into a segment.

Returns:

a new NotationSegment instance.

parse

@Nonnull
public static NotationSegment parse(@Nonnull
                                             String property)

Parses a textual value into an property segment.

Parameters:

property - the property to parse into a segment.

Returns:

a new NotationSegment instance.