Package ch.nolix.core.document.chainednode

Klasse ChainedNode

java.lang.Object

ch.nolix.core.document.chainednode.ChainedNode

Alle implementierten Schnittstellen:

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.

Version:

2016-01-01

Autor:

Silvan Wyss

Feldübersicht

Felder

Modifizierer und Typ	Feld	Beschreibung
static final String	CLOSED_BRACKET_CODE
static final String	COMMA_CODE
static final String	DOLLAR_SYMBOL_CODE
static final String	DOT_CODE
static final String	OPEN_BRACKET_CODE

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
ChainedNode()	Creates a new ChainedNode.
ChainedNode(String header, Iterable<INode<?>> attributes)	Creates a new ChainedNode with the given header and attributes.
ChainedNode(String header, Iterable<INode<?>> attributes, ChainedNode nextNode)	Creates a new ChainedNode with the given header, attributes and nextNode.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
boolean	containsChildNodes()
boolean	equals(Object object)
static ChainedNode	fromNode(INode<?> node)
static ChainedNode	fromString(String string)
ChainedNode	getChildNodeAt1BasedIndex(int index)
int	getChildNodeCount()
IContainer<ChainedNode>	getChildNodes()
IContainer<Node>	getChildNodesAsNodes()
String	getChildNodesAsString()
IContainer<String>	getChildNodesAsStrings()
String	getEscapeHeader()
static String	getEscapeStringFor(String string)
ChainedNode	getFirstChildNodeWithHeader(String header)
String	getHeader()
ChainedNode	getNextNode()
String	getNextNodeAsString()
ChainedNode	getSingleChildNode()
double	getSingleChildNodeAsDouble()
int	getSingleChildNodeAsInt()
Node	getSingleChildNodeAsNode()
String	getSingleChildNodeAsString()
String	getSingleChildNodeHeader()
static String	getStoredginStringFromEscapeString(String escapeString)
int	hashCode()
boolean	hasHeader()
boolean	hasNextNode()
boolean	isBlank()
double	toDouble()
int	toInt()
Node	toNode()	A ChainedNode represents a Node if: -The ChainedNode does not have a next node.
String	toString()
static ChainedNode	withChildNodesFromNodes(INode<?> childNode, INode<?>... childNodes)
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, ChainedNode attribute)
static ChainedNode	withHeaderAndChildNode(String header, INode<?> childNode)
static ChainedNode	withHeaderAndChildNodes(String header, ChainedNode childNode, ChainedNode... 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)
static ChainedNode	withHeaderAndNextNodeAndChildNodes(String header, ChainedNode nextNode, IChainedNode childNode, IChainedNode... childNodes)

Von Klasse geerbte Methoden java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Von Schnittstelle geerbte Methoden ch.nolix.coreapi.attributeapi.optionalattributeapi.IOptionalHeaderHolder

getHeaderOrEmptyString, getOptionalHeader, hasHeader

Felddetails

DOT_CODE

public static final String DOT_CODE

Siehe auch:

• Konstantenfeldwerte

COMMA_CODE

public static final String COMMA_CODE

Siehe auch:

• Konstantenfeldwerte

DOLLAR_SYMBOL_CODE

public static final String DOLLAR_SYMBOL_CODE

Siehe auch:

• Konstantenfeldwerte

OPEN_BRACKET_CODE

public static final String OPEN_BRACKET_CODE

Siehe auch:

• Konstantenfeldwerte

CLOSED_BRACKET_CODE

public static final String CLOSED_BRACKET_CODE

Siehe auch:

• Konstantenfeldwerte

Konstruktordetails

ChainedNode

public ChainedNode()

Creates a new ChainedNode.

ChainedNode

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

Creates a new ChainedNode with the given header and attributes.

Parameter:

header -

attributes -

Löst aus:

ArgumentIsNullException - if the given header is null.

InvalidArgumentException - if the given header is blank.

ChainedNode

public ChainedNode(String header,
 Iterable<INode<?>> attributes,
 ChainedNode nextNode)

Creates a new ChainedNode with the given header, attributes and nextNode.

Parameter:

header -

attributes -

nextNode -

Löst aus:

ArgumentIsNullException - if the given header is null.

InvalidArgumentException - if the given header is blank.

ArgumentIsNullException - if the given nextNode is null.

Methodendetails

fromNode

public static ChainedNode fromNode(INode<?> node)

Parameter:

node -

Gibt zurück:

a new ChainedNode from the given node.

fromString

public static ChainedNode fromString(String string)

Parameter:

string -

Gibt zurück:

a new ChainedNode the given string represents.

Löst aus:

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

getEscapeStringFor

public static String getEscapeStringFor(String string)

Parameter:

string -

Gibt zurück:

an escape String for the given string.

getStoredginStringFromEscapeString

public static String getStoredginStringFromEscapeString(String escapeString)

Parameter:

escapeString -

Gibt zurück:

an origin String from the given escapeString.

withChildNodesFromNodes

public static ChainedNode withChildNodesFromNodes(INode<?> childNode,
 INode<?>... childNodes)

Parameter:

childNode -

childNodes -

Gibt zurück:

a new ChainedNode with the given childNodes.

Löst aus:

ArgumentIsNullException - if one of the given childNodes is null.

withChildNodesFromNodes

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

Creates a new ChainedNode with the given attributes.

Parameter:

attributes -

Gibt zurück:

a new ChainedNode with the given attributes.

Löst aus:

ArgumentIsNullException - if one of the given attributes is null.

withHeader

public static ChainedNode withHeader(String header)

Parameter:

header -

Gibt zurück:

a new ChainedNode with the given header.

Löst aus:

ArgumentIsNullException - if the given header is null.

InvalidArgumentException - if the given header is blank.

withHeaderAndChildNode

public static ChainedNode withHeaderAndChildNode(String header,
 ChainedNode attribute)

Parameter:

header -

attribute -

Gibt zurück:

a new ChainedNode with the given header and attribute.

Löst aus:

ArgumentIsNullException - if the given header is null.

InvalidArgumentException - if the given header is blank.

ArgumentIsNullException - if the given attribute is null.

withHeaderAndChildNodes

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

withHeaderAndChildNode

public static ChainedNode withHeaderAndChildNode(String header,
 INode<?> childNode)

Parameter:

header -

childNode -

Gibt zurück:

a new ChainedNode with the given header and childNode.

Löst aus:

ArgumentIsNullException - if the given header is null.

InvalidArgumentException - if the given header is blank.

withHeaderAndChildNodes

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

Parameter:

header -

attributes -

Gibt zurück:

a new ChainedNode with the given header and attributes.

Löst aus:

ArgumentIsNullException - if the given header is null.

InvalidArgumentException - if the given header is blank.

ArgumentIsNullException - 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.

Parameter:

header -

childNode -

childNodes -

Gibt zurück:

a new ChainedNode with the given header and attributes.

Löst aus:

ArgumentIsNullException - if the given header is null.

InvalidArgumentException - if the given header is blank.

ArgumentIsNullException - 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.

Parameter:

header -

attributes -

Gibt zurück:

a new ChainedNode with the given header and attributes.

Löst aus:

ArgumentIsNullException - if the given header is null.

InvalidArgumentException - if the given header is blank.

ArgumentIsNullException - if one of the given attributes is null.

withHeaderAndNextNode

public static ChainedNode withHeaderAndNextNode(String header,
 ChainedNode nextNode)

Parameter:

header -

nextNode -

Gibt zurück:

a new ChainedNode with the given header and nextNode.

Löst aus:

ArgumentIsNullException - if the given header is null.

InvalidArgumentException - if the given header is blank.

ArgumentIsNullException - if the given nextNode is null.

withHeaderAndNextNodeAndChildNodes

public static ChainedNode withHeaderAndNextNodeAndChildNodes(String header,
 ChainedNode nextNode,
 IChainedNode childNode,
 IChainedNode... childNodes)

Parameter:

header -

nextNode -

childNode -

childNodes -

Gibt zurück:

a new ChainedNode with the given header and nextNode.

Löst aus:

ArgumentIsNullException - if the given header is null.

InvalidArgumentException - if the given header is blank.

ArgumentIsNullException - if the given nextNode is null.

ArgumentIsNullException - if one of the given childNodes is null.

containsChildNodes

public boolean containsChildNodes()

Angegeben von:

containsChildNodes in Schnittstelle IChainedNode

Gibt zurück:

true if the current IChainedNode contains child nodes.

equals

public boolean equals(Object object)

Setzt außer Kraft:

equals in Klasse Object

getChildNodeCount

public int getChildNodeCount()

Angegeben von:

getChildNodeCount in Schnittstelle IChainedNode

Gibt zurück:

the number of attributes of the current ChainedNode.

getChildNodeAt1BasedIndex

public ChainedNode getChildNodeAt1BasedIndex(int index)

Angegeben von:

getChildNodeAt1BasedIndex in Schnittstelle IChainedNode

Parameter:

index -

Gibt zurück:

the attribute at the given index of the current ChainedNode.

Löst aus:

NonPositiveArgumentException - 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()

Angegeben von:

getChildNodes in Schnittstelle IChainedNode

Gibt zurück:

the attributes of the current ChainedNode.

getChildNodesAsNodes

public IContainer<Node> getChildNodesAsNodes()

Gibt zurück:

the Node representations of the attributes of the current ChainedNode.

Löst aus:

UnrepresentingArgumentException - if one of the attributes of the current ChainedNode does not represent a Node.

getChildNodesAsString

public String getChildNodesAsString()

Gibt zurück:

a String representation of the attributes of the current ChainedNode.

getChildNodesAsStrings

public IContainer<String> getChildNodesAsStrings()

Gibt zurück:

the String representations of the attributes of the current ChainedNode.

getEscapeHeader

public String getEscapeHeader()

Gibt zurück:

a reproducing String representation of the header of the current ChainedNode.

Löst aus:

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

getFirstChildNodeWithHeader

public ChainedNode getFirstChildNodeWithHeader(String header)

Angegeben von:

getFirstChildNodeWithHeader in Schnittstelle IChainedNode

Parameter:

header -

Gibt zurück:

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

Löst aus:

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

getHeader

public String getHeader()

Angegeben von:

getHeader in Schnittstelle IOptionalHeaderHolder

Gibt zurück:

the header of the current ChainedNode.

Löst aus:

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

getNextNode

public ChainedNode getNextNode()

Angegeben von:

getNextNode in Schnittstelle IChainedNode

Gibt zurück:

the next node of the current ChainedNode.

Löst aus:

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

getNextNodeAsString

public String getNextNodeAsString()

Gibt zurück:

a String representation of the next node of the current ChainedNode.

Löst aus:

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

getSingleChildNode

public ChainedNode getSingleChildNode()

Angegeben von:

getSingleChildNode in Schnittstelle IChainedNode

Gibt zurück:

the one attribute of the current ChainedNode.

Löst aus:

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

InvalidArgumentException - if the current ChainedNode contains several attributes.

getSingleChildNodeHeader

public String getSingleChildNodeHeader()

Angegeben von:

getSingleChildNodeHeader in Schnittstelle IChainedNode

Gibt zurück:

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

getSingleChildNodeAsDouble

public double getSingleChildNodeAsDouble()

Gibt zurück:

a Double representation of the one attribute of the current ChainedNode.

Löst aus:

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

InvalidArgumentException - if the current ChainedNode contains several attributes.

UnrepresentingArgumentException - if the one attribute of the current ChainedNode does not represent a Double.

getSingleChildNodeAsInt

public int getSingleChildNodeAsInt()

Gibt zurück:

a Integer representation of the one attribute of the current ChainedNode.

Löst aus:

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

InvalidArgumentException - if the current ChainedNode contains several attributes.

UnrepresentingArgumentException - if the one attribute of the current ChainedNode does not represent a Integer.

getSingleChildNodeAsNode

public Node getSingleChildNodeAsNode()

Gibt zurück:

a Node representation of the one attribute of the current ChainedNode.

Löst aus:

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

InvalidArgumentException - if the current ChainedNode contains several attributes.

UnrepresentingArgumentException - if the one attribute of the current ChainedNode does not represent a Node.

getSingleChildNodeAsString

public String getSingleChildNodeAsString()

Gibt zurück:

a String representation of the one attribute of the current ChainedNode.

Löst aus:

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

InvalidArgumentException - if the current ChainedNode contains several attributes.

hashCode

public int hashCode()

Setzt außer Kraft:

hashCode in Klasse Object

hasHeader

public boolean hasHeader()

Angegeben von:

hasHeader in Schnittstelle IOptionalHeaderHolder

Gibt zurück:

true if the current IOptionalHeaderHolder has a header.

hasNextNode

public boolean hasNextNode()

Angegeben von:

hasNextNode in Schnittstelle IChainedNode

Gibt zurück:

true if the current ChainedNode has a next node.

isBlank

public boolean isBlank()

Angegeben von:

isBlank in Schnittstelle BlanknessRequestable

Gibt zurück:

true if the current ChainedNode does not have a header and does not contains attributes.

toDouble

public double toDouble()

Angegeben von:

toDouble in Schnittstelle IChainedNode

Gibt zurück:

a Double representation of the current ChainedNode.

Löst aus:

UnrepresentingArgumentException - if the current ChainedNode does not represent a Double.

toInt

public int toInt()

Angegeben von:

toInt in Schnittstelle IChainedNode

Gibt zurück:

the int the current IChainedNode represents.

toNode

public Node toNode()

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

Angegeben von:

toNode in Schnittstelle IChainedNode

Gibt zurück:

a Node representation of the current ChainedNode.

Löst aus:

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

toString

public String toString()

Setzt außer Kraft:

toString in Klasse Object