Class ChainedNode

java.lang.Object

ch.nolix.base.document.chainednode.ChainedNode

All Implemented Interfaces:

IOptionalHeaderHolder, IChainedNode, BlanknessRequestable

public final class ChainedNode
extends Object
implements IChainedNode

A ChainedNode has the following attributes. -0 or 1 header -an arbitrary number of child ChainedNodes -0 or 1 next ChainedNode A ChainedNode 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 ChainedNode	EMPTY_CHAINED_NODE
static final String	OPEN_BRACKET_CODE

Method Summary

Modifier and Type	Method	Description
boolean	containsChildNodes()
boolean	equals(Object object)
static ChainedNode	fromChainedNode(IChainedNode chainedNode)
static ChainedNode	fromNode(INode<?> node)
static ChainedNode	fromString(String string)
ChainedNode	getChildNodeAtOneBasedIndex(int index)
int	getChildNodeCount()
IContainer<ChainedNode>	getChildNodes()
static String	getEscapeStringForString(String string)
ChainedNode	getFirstChildNodeWithHeader(String header)
String	getHeader()
ChainedNode	getNextNode()
ChainedNode	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()
Node	toNode()	A IChainedNode represents a INode if: -The IChainedNode does not have a next node.
String	toString()
static ChainedNode	withChildNodes(INode<?>... nodes)
static ChainedNode	withChildNodesFromNodes(Iterable<? extends INode<?>> attributes)	Creates a new ChainedNode with the given attributes.
static ChainedNode	withHeader(String header)
static ChainedNode	withHeaderAndChildNode(String header, IChainedNode childNode)
static ChainedNode	withHeaderAndChildNode(String header, INode<?> childNode)
static ChainedNode	withHeaderAndChildNodes(String header, IChainedNode... childNodes)
static ChainedNode	withHeaderAndChildNodes(String header, Iterable<? extends IChainedNode> attributes)
static ChainedNode	withHeaderAndChildNodesFromNodes(String header, INode<?> childNode, INode<?>... childNodes)	Creates a new ChainedNode with the given header and attributes.
static ChainedNode	withHeaderAndChildNodesFromNodes(String header, Iterable<? extends INode<?>> attributes)	Creates a new ChainedNode with the given header and attributes.
static ChainedNode	withHeaderAndNextNode(String header, ChainedNode nextNode)

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface IOptionalHeaderHolder

getHeaderOrEmptyString, getOptionalHeader, hasHeader

Field Details

EMPTY_CHAINED_NODE

public static final ChainedNode 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 ChainedNode fromChainedNode(IChainedNode chainedNode)

Parameters:

chainedNode -

Returns:

a ChainedNode from the given chainedNode.

Throws:

RuntimeException - if the given chainedNode is null.

fromNode

public static ChainedNode fromNode(INode<?> node)

Parameters:

node -

Returns:

a new ChainedNode from the given node.

fromString

public static ChainedNode fromString(String string)

Parameters:

string -

Returns:

a new ChainedNode the given string represents.

Throws:

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

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 ChainedNode withChildNodes(INode<?>... nodes)

Parameters:

nodes -

Returns:

a new ChainedNode with the childNodes

Throws:

RuntimeException - if the given nodes is null.

RuntimeException - if one of the given nodes is null.

withChildNodesFromNodes

public static ChainedNode withChildNodesFromNodes(Iterable<? extends INode<?>> attributes)

Creates a new ChainedNode with the given attributes.

Parameters:

attributes -

Returns:

a new ChainedNode with the given attributes.

Throws:

RuntimeException - if one of the given attributes is null.

withHeader

public static ChainedNode withHeader(String header)

Parameters:

header -

Returns:

a new ChainedNode with the given header.

Throws:

RuntimeException - if the given header is null.

RuntimeException - if the given header is blank.

withHeaderAndChildNode

public static ChainedNode withHeaderAndChildNode(String header,
 IChainedNode childNode)

Parameters:

header -

childNode -

Returns:

a new ChainedNode 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 ChainedNode withHeaderAndChildNodes(String header,
 IChainedNode... childNodes)

Parameters:

header -

childNodes -

Returns:

a new ChainedNode 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 ChainedNode withHeaderAndChildNode(String header,
 INode<?> childNode)

Parameters:

header -

childNode -

Returns:

a new ChainedNode 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 ChainedNode withHeaderAndChildNodes(String header,
 Iterable<? extends IChainedNode> attributes)

Parameters:

header -

attributes -

Returns:

a new ChainedNode 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.

withHeaderAndChildNodesFromNodes

public static ChainedNode withHeaderAndChildNodesFromNodes(String header,
 INode<?> childNode,
 INode<?>... childNodes)

Creates a new ChainedNode with the given header and attributes.

Parameters:

header -

childNode -

childNodes -

Returns:

a new ChainedNode 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.

withHeaderAndChildNodesFromNodes

public static ChainedNode withHeaderAndChildNodesFromNodes(String header,
 Iterable<? extends INode<?>> attributes)

Creates a new ChainedNode with the given header and attributes.

Parameters:

header -

attributes -

Returns:

a new ChainedNode 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 ChainedNode withHeaderAndNextNode(String header,
 ChainedNode nextNode)

Parameters:

header -

nextNode -

Returns:

a new ChainedNode 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 IChainedNode

Returns:

true if the current IChainedNode 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 IChainedNode

Returns:

the number of attributes of the current ChainedNode.

getChildNodeAtOneBasedIndex

public ChainedNode getChildNodeAtOneBasedIndex(int index)

Specified by:

getChildNodeAtOneBasedIndex in interface IChainedNode

Parameters:

index -

Returns:

the attribute at the given index of the current ChainedNode.

Throws:

RuntimeException - if the given index is not positive.

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

getChildNodes

public IContainer<ChainedNode> getChildNodes()

Specified by:

getChildNodes in interface IChainedNode

Returns:

the attributes of the current ChainedNode.

getFirstChildNodeWithHeader

public ChainedNode getFirstChildNodeWithHeader(String header)

Specified by:

getFirstChildNodeWithHeader in interface IChainedNode

Parameters:

header -

Returns:

the first attribute with the given header from the current ChainedNode.

Throws:

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

getHeader

public String getHeader()

Specified by:

getHeader in interface IOptionalHeaderHolder

Returns:

the header of the current ChainedNode.

Throws:

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

getNextNode

public ChainedNode getNextNode()

Specified by:

getNextNode in interface IChainedNode

Returns:

the next node of the current ChainedNode.

Throws:

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

getSingleChildNode

public ChainedNode getSingleChildNode()

Specified by:

getSingleChildNode in interface IChainedNode

Returns:

the one attribute of the current ChainedNode.

Throws:

RuntimeException - if the current ChainedNode does not contain an attribute.

RuntimeException - if the current ChainedNode contains several attributes.

getSingleChildNodeHeader

public String getSingleChildNodeHeader()

Specified by:

getSingleChildNodeHeader in interface IChainedNode

Returns:

the header of the single child node of the current IChainedNode.

getSingleChildNodeAsDouble

public double getSingleChildNodeAsDouble()

Specified by:

getSingleChildNodeAsDouble in interface IChainedNode

Returns:

a double representation of the single child node of the current IChainedNode.

getSingleChildNodeAsInt

public int getSingleChildNodeAsInt()

Specified by:

getSingleChildNodeAsInt in interface IChainedNode

Returns:

a int representation of the single child node of the current IChainedNode.

getSingleChildNodeAsString

public String getSingleChildNodeAsString()

Specified by:

getSingleChildNodeAsString in interface IChainedNode

Returns:

a String representation of the single child node of the current IChainedNode.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

hasHeader

public boolean hasHeader()

Specified by:

hasHeader in interface IOptionalHeaderHolder

Returns:

true if the current IOptionalHeaderHolder has a header, false otherwise.

hasNextNode

public boolean hasNextNode()

Specified by:

hasNextNode in interface IChainedNode

Returns:

true if the current IChainedNode 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 IChainedNode

Returns:

the double the current IChainedNode represents.

toInt

public int toInt()

Specified by:

toInt in interface IChainedNode

Returns:

the int the current IChainedNode represents.

toNode

public Node toNode()

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

Specified by:

toNode in interface IChainedNode

Returns:

a INode representation of the current IChainedNode.

toString

public String toString()

Overrides:

toString in class Object