Class Node

java.lang.Object

ch.nolix.base.document.node.AbstractNode<Node>

ch.nolix.base.document.node.Node

All Implemented Interfaces:

IOptionalHeaderHolder, INode<Node>, BlanknessRequestable

public final class Node
extends AbstractNode<Node>

A Node is not mutable.

Author:

Silvan Wyss

Field Summary

Fields

Modifier and Type	Field	Description
static final Node	EMPTY_NODE

Fields inherited from class AbstractNode

CLOSED_BRACKET_CODE, COMMA_CODE, DOLLAR_SYMBOL_CODE, OPEN_BRACKET_CODE

Method Summary

Modifier and Type	Method	Description
INode<?>	asWithHeader(String header)
static Node	fromEnum(Enum<?> pEnum)
static Node	fromFile(String filePath)
static Node	fromNode(INode<?> node)
static Node	fromString(String string)
String	getHeader()
IContainer<Node>	getStoredChildNodes()
boolean	hasHeader()
static Node	withChildNode(boolean childNode)
static Node	withChildNode(double childNode)
static Node	withChildNode(long childNode)
static Node	withChildNode(INode<?> childNode)
static Node	withChildNodes(INode<?>... childNodes)
static Node	withChildNodes(Iterable<? extends INode<?>> childNodes)
static Node	withChildNodes(String... childNodes)
static Node	withHeader(boolean header)
static Node	withHeader(double header)
static Node	withHeader(long header)
static Node	withHeader(String header)
static Node	withHeaderAndChildNode(String header, boolean childNode)
static Node	withHeaderAndChildNode(String header, double childNode)
static Node	withHeaderAndChildNode(String header, long childNode)
static Node	withHeaderAndChildNode(String header, INode<?> childNode, INode<?>... childNodes)
static Node	withHeaderAndChildNode(String header, String childNode)
static Node	withHeaderAndChildNodes(String header, Iterable<? extends INode<?>> childNodes)
static Node	withHeaderAndChildNodes(String header, String... childNodes)

Methods inherited from class AbstractNode

containsChildNodes, containsChildNodeThat, containsChildNodeWithHeader, containsOneChildNode, equals, getChildNodeCount, getChildNodeCount, getChildNodesHeaders, getEscapeStringFor, getOptionalStoredFirstChildNodeThat, getOriginStringFromEscapeString, getSingleChildNodeAsBoolean, getSingleChildNodeAsDouble, getSingleChildNodeAsInt, getSingleChildNodeHeader, getStoredChildNodeAtOneBasedIndex, getStoredChildNodesThat, getStoredChildNodesWithHeader, getStoredFirstChildNode, getStoredFirstChildNodeThat, getStoredFirstChildNodeWithHeader, getStoredSingleChildNode, hashCode, isBlank, saveToFile, saveToFile, toBoolean, toDouble, toFormattedString, toInt, toString, toXml

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface IOptionalHeaderHolder

getHeaderOrEmptyString, getOptionalHeader, hasHeader

Field Details

EMPTY_NODE

public static final Node EMPTY_NODE

Method Details

fromEnum

public static Node fromEnum(Enum<?> pEnum)

Parameters:

pEnum -

Returns:

a new Node from the given pEnum.

fromFile

public static Node fromFile(String filePath)

Parameters:

filePath -

Returns:

a new Node from the file with the given filePath.

Throws:

RuntimeException - if the given filePath is not valid.

RuntimeException - if the file with the given filePath does not represent a Node.

fromNode

public static Node fromNode(INode<?> node)

Parameters:

node -

Returns:

a new Node from the given INode.

fromString

public static Node fromString(String string)

Parameters:

string -

Returns:

a new Node from the given string.

Throws:

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

withChildNode

public static Node withChildNode(boolean childNode)

Parameters:

childNode -

Returns:

a new Node with the given childNode.

withChildNode

public static Node withChildNode(double childNode)

Parameters:

childNode -

Returns:

a new Node with the given childNode.

withChildNode

public static Node withChildNode(long childNode)

Parameters:

childNode -

Returns:

a new Node with the given childNode.

withChildNodes

public static Node withChildNodes(Iterable<? extends INode<?>> childNodes)

Parameters:

childNodes -

Returns:

a new Node with the given childNodes.

withChildNode

public static Node withChildNode(INode<?> childNode)

Parameters:

childNode -

Returns:

a new Node with the given childNode.

withChildNodes

public static Node withChildNodes(INode<?>... childNodes)

Parameters:

childNodes -

Returns:

a new Node with the given childNodes.

withChildNodes

public static Node withChildNodes(String... childNodes)

Parameters:

childNodes -

Returns:

a new Node with the given childNodes.

Throws:

RuntimeException - if the given childNodes is null.

RuntimeException - if one of the given childNodes is null.

withHeader

public static Node withHeader(boolean header)

Parameters:

header -

Returns:

a new Node with the given header.

withHeader

public static Node withHeader(double header)

Parameters:

header -

Returns:

a new Node with the given header.

withHeader

public static Node withHeader(long header)

Parameters:

header -

Returns:

a new Node with the given header.

withHeader

public static Node withHeader(String header)

Parameters:

header -

Returns:

a new Node with the given header.

Throws:

RuntimeException - if the given header is null.

RuntimeException - if the given header is blank.

withHeaderAndChildNode

public static Node withHeaderAndChildNode(String header,
 boolean childNode)

Parameters:

header -

childNode -

Returns:

a new Node with the given childNode.

Throws:

RuntimeException - if the given header is null.

RuntimeException - if the given header is blank.

withHeaderAndChildNode

public static Node withHeaderAndChildNode(String header,
 double childNode)

Parameters:

header -

childNode -

Returns:

a new Node with the given childNode.

Throws:

RuntimeException - if the given header is null.

RuntimeException - if the given header is blank.

withHeaderAndChildNode

public static Node withHeaderAndChildNode(String header,
 INode<?> childNode,
 INode<?>... childNodes)

Parameters:

header -

childNode -

childNodes -

Returns:

a new Node with the given header and childNodes.

Throws:

RuntimeException - if the given header is null.

RuntimeException - if the given header is blank.

withHeaderAndChildNode

public static Node withHeaderAndChildNode(String header,
 long childNode)

Parameters:

header -

childNode -

Returns:

a new Node with the given childNode.

Throws:

RuntimeException - if the given header is null.

RuntimeException - if the given header is blank.

withHeaderAndChildNode

public static Node withHeaderAndChildNode(String header,
 String childNode)

Parameters:

header -

childNode -

Returns:

a new Node 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 Node withHeaderAndChildNodes(String header,
 Iterable<? extends INode<?>> childNodes)

Parameters:

header -

childNodes -

Returns:

a new Node with the given childNodes.

Throws:

RuntimeException - if the given header is null.

RuntimeException - if the given header is blank.

withHeaderAndChildNodes

public static Node withHeaderAndChildNodes(String header,
 String... childNodes)

Parameters:

header -

childNodes -

Returns:

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

asWithHeader

public INode<?> asWithHeader(String header)

Parameters:

header -

Returns:

a new INode that is a copy of the current INode with the given header.

getHeader

public String getHeader()

Returns:

the header of the current IOptionalHeaderHolder.

getStoredChildNodes

public IContainer<Node> getStoredChildNodes()

Returns:

the child INodes of the current INode.

hasHeader

public boolean hasHeader()

Returns:

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