Interface ChainedNode

All Superinterfaces:

BlanknessRequestable, OptionalHeaderHolder

All Known Implementing Classes:

ImmutableChainedNode

public interface ChainedNode
extends BlanknessRequestable, OptionalHeaderHolder

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

Author:

Silvan Wyss

Method Summary

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

Methods inherited from interface BlanknessRequestable

isBlank

Methods inherited from interface OptionalHeaderHolder

getHeader, getHeaderOrEmptyString, getOptionalHeader, hasHeader, hasHeader

Method Details

containsChildNodes

boolean containsChildNodes()

Returns:

true if the current ChainedNode contains child nodes, false otherwise

getChildNodeAtOneBasedIndex

ChainedNode getChildNodeAtOneBasedIndex(int oneBasedIndex)

Parameters:

oneBasedIndex -

Returns:

the child node of the current ChainedNode at the given oneBasedIndex

Throws:

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

getChildNodeCount

int getChildNodeCount()

Returns:

the number of child nodes of the current ChainedNode.

getChildNodes

ExtendedIterable<? extends ChainedNode> getChildNodes()

Returns:

the child nodes of the current ChainedNode.

getFirstChildNodeWithHeader

ChainedNode getFirstChildNodeWithHeader(String header)

Parameters:

header -

Returns:

the first child node with the given header from the current ChainedNode

Throws:

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

getNextNode

ChainedNode getNextNode()

Returns:

the next node of the current ChainedNode

Throws:

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

getSingleChildNode

ChainedNode getSingleChildNode()

Returns:

the single child node of the current ChainedNode

Throws:

RuntimeException - if the current ChainedNode 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 ChainedNode

Throws:

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

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

getSingleChildNodeAsDouble

double getSingleChildNodeAsDouble()

Returns:

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

Throws:

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

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

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

getSingleChildNodeAsInt

int getSingleChildNodeAsInt()

Returns:

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

Throws:

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

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

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

getSingleChildNodeAsString

String getSingleChildNodeAsString()

Returns:

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

Throws:

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

hasNextNode

boolean hasNextNode()

Returns:

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

toDouble

double toDouble()

Returns:

the double the current ChainedNode represents

Throws:

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

toInt

int toInt()

Returns:

the int the current ChainedNode represents

Throws:

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

toNode

Node<?> toNode()

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

Returns:

a Node representation of the current ChainedNode

Throws:

RuntimeException - if the current ChainedNode does not represent a Node.