Class ImmutableChainedNode

java.lang.Object

ch.nolix.base.document.chainednode.ImmutableChainedNode

All Implemented Interfaces:

OptionalHeaderHolder, ChainedNode, BlanknessRequestable

public final class ImmutableChainedNode
extends Object
implements ChainedNode

A ImmutableChainedNode has the following attributes. -0 or 1 header -an arbitrary number of child ImmutableChainedNodes -0 or 1 next ImmutableChainedNode A ImmutableChainedNode is not mutable.

Author:

Silvan Wyss

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CLOSED_BRACKET_CODE
static final String	COMMA_CODE
static final String	DOLLAR_SYMBOL_CODE
static final String	DOT_CODE
static final ImmutableChainedNode	EMPTY_CHAINED_NODE
static final String	OPEN_BRACKET_CODE

Method Summary

Modifier and Type	Method	Description
boolean	containsChildNodes()
boolean	equals(Object object)
static ImmutableChainedNode	fromChainedNode(ChainedNode chainedNode)
static ImmutableChainedNode	fromNode(Node<?> node)
static ImmutableChainedNode	fromString(String string)
ImmutableChainedNode	getChildNodeAtOneBasedIndex(int index)
int	getChildNodeCount()
ExtendedIterable<ImmutableChainedNode>	getChildNodes()
static String	getEscapeStringForString(String string)
ImmutableChainedNode	getFirstChildNodeWithHeader(String header)
String	getHeader()
ImmutableChainedNode	getNextNode()
ImmutableChainedNode	getSingleChildNode()
double	getSingleChildNodeAsDouble()
int	getSingleChildNodeAsInt()
String	getSingleChildNodeAsString()
String	getSingleChildNodeHeader()
static String	getStoredginStringFromEscapeString(String escapeString)
int	hashCode()
boolean	hasHeader()
boolean	hasNextNode()
boolean	isBlank()
double	toDouble()
int	toInt()
ImmutableNode	toNode()	A ChainedNode represents a Node if: -The ChainedNode does not have a next node.
String	toString()
static ImmutableChainedNode	withChildNodes(Node<?>... nodes)
static ImmutableChainedNode	withChildNodesFromNodes(Iterable<? extends Node<?>> attributes)	Creates a new ImmutableChainedNode with the given attributes.
static ImmutableChainedNode	withHeader(String header)
static ImmutableChainedNode	withHeaderAndChildNode(String header, ChainedNode childNode)
static ImmutableChainedNode	withHeaderAndChildNode(String header, Node<?> childNode)
static ImmutableChainedNode	withHeaderAndChildNodes(String header, ChainedNode... childNodes)
static ImmutableChainedNode	withHeaderAndChildNodes(String header, Node<?>... childNodes)
static ImmutableChainedNode	withHeaderAndChildNodes(String header, Iterable<? extends ChainedNode> attributes)
static ImmutableChainedNode	withHeaderAndChildNodesFromNodes(String header, Iterable<? extends Node<?>> attributes)	Creates a new ImmutableChainedNode with the given header and attributes.
static ImmutableChainedNode	withHeaderAndNextNode(String header, ImmutableChainedNode nextNode)

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface OptionalHeaderHolder

getHeaderOrEmptyString, getOptionalHeader, hasHeader

Field Details

EMPTY_CHAINED_NODE

public static final ImmutableChainedNode EMPTY_CHAINED_NODE

DOT_CODE

public static final String DOT_CODE

See Also:

• Constant Field Values

COMMA_CODE

public static final String COMMA_CODE

See Also:

• Constant Field Values

DOLLAR_SYMBOL_CODE

public static final String DOLLAR_SYMBOL_CODE

See Also:

• Constant Field Values

OPEN_BRACKET_CODE

public static final String OPEN_BRACKET_CODE

See Also:

• Constant Field Values

CLOSED_BRACKET_CODE

public static final String CLOSED_BRACKET_CODE

See Also:

• Constant Field Values

Method Details

fromChainedNode

public static ImmutableChainedNode fromChainedNode(ChainedNode chainedNode)

Parameters:

chainedNode -

Returns:

a ImmutableChainedNode from the given chainedNode

Throws:

RuntimeException - if the given chainedNode is null

fromNode

public static ImmutableChainedNode fromNode(Node<?> node)

Parameters:

node -

Returns:

a new ImmutableChainedNode from the given node.

fromString

public static ImmutableChainedNode fromString(String string)

Parameters:

string -

Returns:

a new ImmutableChainedNode the given string represents

Throws:

RuntimeException - if the given string does not represent a ImmutableChainedNode.

getEscapeStringForString

public static String getEscapeStringForString(String string)

Parameters:

string -

Returns:

an escape String for the given string.

getStoredginStringFromEscapeString

public static String getStoredginStringFromEscapeString(String escapeString)

Parameters:

escapeString -

Returns:

an origin String from the given escapeString.

withChildNodes

public static ImmutableChainedNode withChildNodes(Node<?>... nodes)

Parameters:

nodes -

Returns:

a new ImmutableChainedNode with the childNodes

Throws:

RuntimeException - if the given nodes is null

RuntimeException - if one of the given nodes is null

withChildNodesFromNodes

public static ImmutableChainedNode withChildNodesFromNodes(Iterable<? extends Node<?>> attributes)

Creates a new ImmutableChainedNode with the given attributes.

Parameters:

attributes -

Returns:

a new ImmutableChainedNode with the given attributes

Throws:

RuntimeException - if one of the given attributes is null

withHeader

public static ImmutableChainedNode withHeader(String header)

Parameters:

header -

Returns:

a new ImmutableChainedNode with the given header

Throws:

RuntimeException - if the given header is null

RuntimeException - if the given header is blank

withHeaderAndChildNode

public static ImmutableChainedNode withHeaderAndChildNode(String header,
 ChainedNode childNode)

Parameters:

header -

childNode -

Returns:

a new ImmutableChainedNode with the given header and childNode

Throws:

RuntimeException - if the given header is null or blank

RuntimeException - if the given childNode is null

withHeaderAndChildNodes

public static ImmutableChainedNode withHeaderAndChildNodes(String header,
 ChainedNode... childNodes)

Parameters:

header -

childNodes -

Returns:

a new ImmutableChainedNode with the given header and childNodes

Throws:

RuntimeException - if the given header is null or blank

RuntimeException - if the given header is blank

RuntimeException - if the given childNodes is null

RuntimeException - if one of the given childNodes is null

withHeaderAndChildNode

public static ImmutableChainedNode withHeaderAndChildNode(String header,
 Node<?> childNode)

Parameters:

header -

childNode -

Returns:

a new ImmutableChainedNode with the given header and childNode

Throws:

RuntimeException - if the given header is null or blank

RuntimeException - if the given header is blank

withHeaderAndChildNodes

public static ImmutableChainedNode withHeaderAndChildNodes(String header,
 Iterable<? extends ChainedNode> attributes)

Parameters:

header -

attributes -

Returns:

a new ImmutableChainedNode with the given header and attributes

Throws:

RuntimeException - if the given header is null

RuntimeException - if the given header is blank

RuntimeException - if one of the given attribute is null

withHeaderAndChildNodes

public static ImmutableChainedNode withHeaderAndChildNodes(String header,
 Node<?>... childNodes)

Parameters:

header -

childNodes -

Returns:

a new ImmutableChainedNode with the given header and childNodes

Throws:

RuntimeException - if the given header is null or blank

RuntimeException - if the given childNodes is null

RuntimeException - if one of the given childNodes is null

withHeaderAndChildNodesFromNodes

public static ImmutableChainedNode withHeaderAndChildNodesFromNodes(String header,
 Iterable<? extends Node<?>> attributes)

Creates a new ImmutableChainedNode with the given header and attributes.

Parameters:

header -

attributes -

Returns:

a new ImmutableChainedNode with the given header and attributes

Throws:

RuntimeException - if the given header is null

RuntimeException - if the given header is blank

RuntimeException - if one of the given attributes is null

withHeaderAndNextNode

public static ImmutableChainedNode withHeaderAndNextNode(String header,
 ImmutableChainedNode nextNode)

Parameters:

header -

nextNode -

Returns:

a new ImmutableChainedNode with the given header and nextNode

Throws:

RuntimeException - if the given header is null

RuntimeException - if the given header is blank

RuntimeException - if the given nextNode is null

containsChildNodes

public boolean containsChildNodes()

Specified by:

containsChildNodes in interface ChainedNode

Returns:

true if the current ChainedNode contains child nodes, false otherwise

equals

public boolean equals(Object object)

Overrides:

equals in class Object

getChildNodeCount

public int getChildNodeCount()

Specified by:

getChildNodeCount in interface ChainedNode

Returns:

the number of attributes of the current ImmutableChainedNode.

getChildNodeAtOneBasedIndex

public ImmutableChainedNode getChildNodeAtOneBasedIndex(int index)

Specified by:

getChildNodeAtOneBasedIndex in interface ChainedNode

Parameters:

index -

Returns:

the attribute at the given index of the current ImmutableChainedNode

Throws:

RuntimeException - if the given index is not positive

ArgumentDoesNotHaveAttributeException - if the current ImmutableChainedNode does not contain an attribute at the given index.

getChildNodes

public ExtendedIterable<ImmutableChainedNode> getChildNodes()

Specified by:

getChildNodes in interface ChainedNode

Returns:

the attributes of the current ImmutableChainedNode.

getFirstChildNodeWithHeader

public ImmutableChainedNode getFirstChildNodeWithHeader(String header)

Specified by:

getFirstChildNodeWithHeader in interface ChainedNode

Parameters:

header -

Returns:

the first attribute with the given header from the current ImmutableChainedNode

Throws:

ArgumentDoesNotHaveAttributeException - if the current ImmutableChainedNode does not contain an attribute with the given header.

getHeader

public String getHeader()

Specified by:

getHeader in interface OptionalHeaderHolder

Returns:

the header of the current ImmutableChainedNode

Throws:

ArgumentDoesNotHaveAttributeException - if the current ImmutableChainedNode does not have a header.

getNextNode

public ImmutableChainedNode getNextNode()

Specified by:

getNextNode in interface ChainedNode

Returns:

the next node of the current ImmutableChainedNode

Throws:

ArgumentDoesNotHaveAttributeException - if the current ImmutableChainedNode does not have a next node.

getSingleChildNode

public ImmutableChainedNode getSingleChildNode()

Specified by:

getSingleChildNode in interface ChainedNode

Returns:

the one attribute of the current ImmutableChainedNode

Throws:

RuntimeException - if the current ImmutableChainedNode does not contain an attribute

RuntimeException - if the current ImmutableChainedNode contains several attributes.

getSingleChildNodeHeader

public String getSingleChildNodeHeader()

Specified by:

getSingleChildNodeHeader in interface ChainedNode

Returns:

the header of the single child node of the current ChainedNode

getSingleChildNodeAsDouble

public double getSingleChildNodeAsDouble()

Specified by:

getSingleChildNodeAsDouble in interface ChainedNode

Returns:

a double representation of the single child node of the current ChainedNode

getSingleChildNodeAsInt

public int getSingleChildNodeAsInt()

Specified by:

getSingleChildNodeAsInt in interface ChainedNode

Returns:

a int representation of the single child node of the current ChainedNode

getSingleChildNodeAsString

public String getSingleChildNodeAsString()

Specified by:

getSingleChildNodeAsString in interface ChainedNode

Returns:

a String representation of the single child node of the current ChainedNode

hashCode

public int hashCode()

Overrides:

hashCode in class Object

hasHeader

public boolean hasHeader()

Specified by:

hasHeader in interface OptionalHeaderHolder

Returns:

true if the current OptionalHeaderHolder has a header, false otherwise

hasNextNode

public boolean hasNextNode()

Specified by:

hasNextNode in interface ChainedNode

Returns:

true if the current ChainedNode has a next node, false otherwise

isBlank

public boolean isBlank()

Specified by:

isBlank in interface BlanknessRequestable

Returns:

true if BlanknessRequestable is blank, false otherwise

toDouble

public double toDouble()

Specified by:

toDouble in interface ChainedNode

Returns:

the double the current ChainedNode represents

toInt

public int toInt()

Specified by:

toInt in interface ChainedNode

Returns:

the int the current ChainedNode represents

toNode

public ImmutableNode toNode()

A ChainedNode represents a Node if: -The ChainedNode does not have a next node. -Each child nodes of the ChainedNode represents a Node.

Specified by:

toNode in interface ChainedNode

Returns:

a Node representation of the current ChainedNode

toString

public String toString()

Overrides:

toString in class Object