Interface IChainedNode

All Superinterfaces:

BlanknessRequestable, IOptionalHeaderHolder

All Known Implementing Classes:

ChainedNode

public interface IChainedNode
extends BlanknessRequestable, IOptionalHeaderHolder

A IChainedNode has the following attributes. -0 or 1 header -an arbitrary number of child IChainedNodes -0 or 1 next IChainedNode A IChainedNode that does not have a header, does not contain attributes and does not have a next IChainedNode is blank. A IChainedNode is not mutable.

Author:

Silvan Wyss

Method Summary

Modifier and Type	Method	Description
boolean	containsChildNodes()
IChainedNode	getChildNodeAtOneBasedIndex(int oneBasedIndex)
int	getChildNodeCount()
IContainer<? extends IChainedNode>	getChildNodes()
IChainedNode	getFirstChildNodeWithHeader(String header)
IChainedNode	getNextNode()
IChainedNode	getSingleChildNode()
double	getSingleChildNodeAsDouble()
int	getSingleChildNodeAsInt()
String	getSingleChildNodeAsString()
String	getSingleChildNodeHeader()
boolean	hasNextNode()
double	toDouble()
int	toInt()
INode<?>	toNode()	A IChainedNode represents a INode if: -The IChainedNode does not have a next node.

Methods inherited from interface BlanknessRequestable

isBlank

Methods inherited from interface IOptionalHeaderHolder

getHeader, getHeaderOrEmptyString, getOptionalHeader, hasHeader, hasHeader

Method Details

containsChildNodes

boolean containsChildNodes()

Returns:

true if the current IChainedNode contains child nodes, false otherwise.

getChildNodeAtOneBasedIndex

IChainedNode getChildNodeAtOneBasedIndex(int oneBasedIndex)

Parameters:

oneBasedIndex -

Returns:

the child node of the current IChainedNode at the given oneBasedIndex .

Throws:

RuntimeException - if the current IChainedNode does not contain a child node at the given oneBasedIndex.

getChildNodeCount

int getChildNodeCount()

Returns:

the number of child nodes of the current IChainedNode.

getChildNodes

IContainer<? extends IChainedNode> getChildNodes()

Returns:

the child nodes of the current IChainedNode.

getFirstChildNodeWithHeader

IChainedNode getFirstChildNodeWithHeader(String header)

Parameters:

header -

Returns:

the first child node with the given header from the current IChainedNode.

Throws:

RuntimeException - if the current IChainedNode does not contain a child node with the given header.

getNextNode

IChainedNode getNextNode()

Returns:

the next node of the current IChainedNode.

Throws:

RuntimeException - if the current IChainedNode does not have a next node.

getSingleChildNode

IChainedNode getSingleChildNode()

Returns:

the single child node of the current IChainedNode.

Throws:

RuntimeException - if the current IChainedNode does not contain a child node or contains multiple child nodes.

getSingleChildNodeHeader

String getSingleChildNodeHeader()

Returns:

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

Throws:

RuntimeException - if the current IChainedNode does not contain a child node or contains multiple child nodes.

RuntimeException - if the single child node of the current IChainedNode does not have a header.

getSingleChildNodeAsDouble

double getSingleChildNodeAsDouble()

Returns:

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

Throws:

RuntimeException - if the current IChainedNode does not contain a child nodes or contains multiple child nodes.

RuntimeException - if the single child node of the current IChainedNode does not have a header.

RuntimeException - if the header of the single child node of the current IChainedNode does not represent a double.

getSingleChildNodeAsInt

int getSingleChildNodeAsInt()

Returns:

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

Throws:

RuntimeException - if the current IChainedNode does not contain a child node or contains multiple child nodes.

RuntimeException - if the single child node of the current IChainedNode does not have a header.

RuntimeException - if the header of the single child node of the current IChainedNode does not represent an int.

getSingleChildNodeAsString

String getSingleChildNodeAsString()

Returns:

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

Throws:

RuntimeException - if the current IChainedNode does not contain a child node or contains multiple child nodes.

hasNextNode

boolean hasNextNode()

Returns:

true if the current IChainedNode has a next node, false otherwise.

toDouble

double toDouble()

Returns:

the double the current IChainedNode represents.

Throws:

RuntimeException - if the current IChainedNode does not represent a double.

toInt

int toInt()

Returns:

the int the current IChainedNode represents.

Throws:

RuntimeException - if the current IChainedNode does not represent an int.

toNode

INode<?> toNode()

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

Returns:

a INode representation of the current IChainedNode.

Throws:

RuntimeException - if the current IChainedNode does not represent a INode.