org.jboss.dna.graph.properties.basic
Class BasicPathSegment

java.lang.Object
  org.jboss.dna.graph.properties.basic.BasicPathSegment

All Implemented Interfaces:

Serializable, Cloneable, Comparable<Path.Segment>, Path.Segment

@Immutable
public class BasicPathSegment
extends Object
implements Path.Segment

A basic implementation of Path.Segment.

Author:

Randall Hauch

See Also:

Serialized Form

Constructor Summary

BasicPathSegment(Name name)

BasicPathSegment(Name name, int index)

Method Summary

int	compareTo(Path.Segment that)
boolean	equals(Object obj)
int	getIndex() Get the index for this segment, which will be 0 if this segment has no specific index.
Name	getName() Get the name component of this segment.
String	getString() Get the string form of the segment.
String	getString(NamespaceRegistry namespaceRegistry) Get the string form of the segment, using the supplied namespace registry to convert the name's namespace URI to a prefix.
String	getString(NamespaceRegistry namespaceRegistry, TextEncoder encoder) Get the encoded string form of the segment, using the supplied namespace registry to convert the name's namespace URI to a prefix and the supplied encoder to encode characters in each of the path segments.
String	getString(NamespaceRegistry namespaceRegistry, TextEncoder encoder, TextEncoder delimiterEncoder) Get the encoded string form of the segment, using the supplied namespace registry to convert the names' namespace URIs to prefixes and the supplied encoder to encode characters in each of the path segments.
String	getString(TextEncoder encoder) Get the encoded string form of the segment, using the supplied encoder to encode characters in each of the path segments.
String	getUnencodedString() Get the raw string form of the segment using the no-op encoder.
int	hashCode()
boolean	hasIndex() Return whether this segment has an index.
boolean	isParentReference() Return whether this segment is a reference to a parent.
boolean	isSelfReference() Return whether this segment is a self-reference.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BasicPathSegment

public BasicPathSegment(Name name)

Parameters:

name - the segment name

Throws:

IllegalArgumentException - if the name is null or if the index is invalid

BasicPathSegment

public BasicPathSegment(Name name,
                        int index)

Parameters:

name - the segment name

index - the segment index

Throws:

IllegalArgumentException - if the name is null or if the index is invalid

Method Detail

getIndex

public int getIndex()

Get the index for this segment, which will be 0 if this segment has no specific index.

Specified by:

getIndex in interface Path.Segment

Returns:

the index

getName

public Name getName()

Get the name component of this segment.

Specified by:

getName in interface Path.Segment

Returns:

the segment's name

hasIndex

public boolean hasIndex()

Return whether this segment has an index.

Specified by:

hasIndex in interface Path.Segment

Returns:

true if this segment has an index, or false otherwise.

isParentReference

public boolean isParentReference()

Return whether this segment is a reference to a parent.

Specified by:

isParentReference in interface Path.Segment

Returns:

true if the segment is a parent-reference, or false otherwise.

isSelfReference

public boolean isSelfReference()

Return whether this segment is a self-reference.

Specified by:

isSelfReference in interface Path.Segment

Returns:

true if the segment is a self-reference, or false otherwise.

compareTo

public int compareTo(Path.Segment that)

Specified by:

compareTo in interface Comparable<Path.Segment>

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getUnencodedString

public String getUnencodedString()

Get the raw string form of the segment using the no-op encoder. This is equivalent to calling getString(Path.NO_OP_ENCODER).

Specified by:

getUnencodedString in interface Path.Segment

Returns:

the un-encoded string

See Also:

Path.Segment.getString(TextEncoder)

getString

public String getString()

Get the string form of the segment. The default encoder is used to encode characters in each of the path segments.

Specified by:

getString in interface Path.Segment

Returns:

the encoded string

See Also:

Path.Segment.getString(TextEncoder)

getString

public String getString(TextEncoder encoder)

Get the encoded string form of the segment, using the supplied encoder to encode characters in each of the path segments.

Specified by:

getString in interface Path.Segment

Parameters:

encoder - the encoder to use, or null if the default encoder should be used

Returns:

the encoded string

See Also:

Path.Segment.getString()

getString

public String getString(NamespaceRegistry namespaceRegistry)

Get the string form of the segment, using the supplied namespace registry to convert the name's namespace URI to a prefix. The default encoder is used to encode characters in each of the path segments.

Specified by:

getString in interface Path.Segment

Parameters:

namespaceRegistry - the namespace registry that should be used to obtain the prefix for the namespace URI in the segment's name

Returns:

the encoded string

See Also:

Path.Segment.getString(NamespaceRegistry,TextEncoder)

getString

public String getString(NamespaceRegistry namespaceRegistry,
                        TextEncoder encoder)

Get the encoded string form of the segment, using the supplied namespace registry to convert the name's namespace URI to a prefix and the supplied encoder to encode characters in each of the path segments.

Specified by:

getString in interface Path.Segment

Parameters:

namespaceRegistry - the namespace registry that should be used to obtain the prefix for the namespace URI in the segment's name

encoder - the encoder to use, or null if the default encoder should be used

Returns:

the encoded string

See Also:

Path.Segment.getString(NamespaceRegistry)

getString

public String getString(NamespaceRegistry namespaceRegistry,
                        TextEncoder encoder,
                        TextEncoder delimiterEncoder)

Get the encoded string form of the segment, using the supplied namespace registry to convert the names' namespace URIs to prefixes and the supplied encoder to encode characters in each of the path segments. The second encoder is used to encode (or convert) the delimiter between the namespace prefix and the local part.

Specified by:

getString in interface Path.Segment

Parameters:

namespaceRegistry - the namespace registry that should be used to obtain the prefix for the namespace URIs in the segment names

encoder - the encoder to use for encoding the local part and namespace prefix in the segment's name, or null if the default encoder should be used

delimiterEncoder - the encoder to use for encoding the delimiter between the local part and namespace prefix of each segment, or null if the standard delimiters should be used

Returns:

the encoded string

See Also:

Path.Segment.getString(org.jboss.dna.graph.properties.NamespaceRegistry, org.jboss.dna.common.text.TextEncoder, org.jboss.dna.common.text.TextEncoder)