Class ImmutableNode

java.lang.Object

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

ch.nolix.base.document.node.ImmutableNode

All Implemented Interfaces:

OptionalHeaderHolder, FormattedStringRepresentable, Node<ImmutableNode>, BlanknessRequestable

public final class ImmutableNode
extends AbstractNode<ImmutableNode>

Author:

Silvan Wyss

Field Summary

Fields

Modifier and Type	Field	Description
static final ImmutableNode	EMPTY_NODE

Fields inherited from interface FormattedStringRepresentable

DEFAULT_IDENTATION_LEVEL, DEFAULT_IDENTTATION_SYMBOL, DEFAULT_START_MULTILINER_WITH_IDENTATION_FLAG

Method Summary

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

Methods inherited from class AbstractNode

containsChildNode, containsChildNodes, containsChildNodeWithHeader, equals, formattedStringWillHaveMultipleLines, getChildNodeCount, getChildNodeCount, getChildNodesHeaders, getEscapeStringFor, getOptionalStoredFirstChildNode, getOriginStringFromEscapeString, getSingleChildNodeAsBoolean, getSingleChildNodeAsDouble, getSingleChildNodeAsInt, getSingleChildNodeHeader, getStoredChildNodeAtOneBasedIndex, getStoredChildNodes, getStoredChildNodesWithHeader, getStoredFirstChildNode, getStoredFirstChildNode, getStoredFirstChildNodeWithHeader, getStoredSingleChildNode, hashCode, isBlank, saveToFile, saveToFile, toBoolean, toDouble, toFormattedStringWithIndentationLevelAndIndentationSymbol, toInt, toString, toXml

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface FormattedStringRepresentable

toFormattedString, toFormattedStringWithIndentationLevel, toFormattedStringWithIndentationLevelAndIndentationSymbol

Methods inherited from interface OptionalHeaderHolder

getHeaderOrEmptyString, getOptionalHeader, hasHeader

Field Details

EMPTY_NODE

public static final ImmutableNode EMPTY_NODE

Method Details

fromEnum

public static ImmutableNode fromEnum(Enum<?> paramEnum)

Parameters:

paramEnum -

Returns:

a new ImmutableNode from the given paramEnum. throws RuntimeException if the given paramEnum is null

fromFile

public static ImmutableNode fromFile(String filePath)

Parameters:

filePath -

Returns:

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

fromNode

public static ImmutableNode fromNode(Node<?> node)

Parameters:

node -

Returns:

a new ImmutableNode from the given Node

Throws:

RuntimeException - if the given node is null

fromString

public static ImmutableNode fromString(String string)

Parameters:

string -

Returns:

a new ImmutableNode from the given string

Throws:

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

withChildNode

public static ImmutableNode withChildNode(boolean childNode)

Parameters:

childNode -

Returns:

a new ImmutableNode with the given childNode.

withChildNode

public static ImmutableNode withChildNode(double childNode)

Parameters:

childNode -

Returns:

a new ImmutableNode with the given childNode.

withChildNode

public static ImmutableNode withChildNode(Node<?> childNode)

Parameters:

childNode -

Returns:

a new ImmutableNode with the given childNode

Throws:

RuntimeException - if the given childNode is null

withChildNode

public static ImmutableNode withChildNode(long childNode)

Parameters:

childNode -

Returns:

a new ImmutableNode with the given childNode.

withChildNodes

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

Parameters:

childNodes -

Returns:

a new ImmutableNode with the given childNodes

Throws:

RuntimeException - if the given childNodes is null

RuntimeException - if one of the given childNodes is null

withChildNodes

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

Parameters:

childNodes -

Returns:

a new ImmutableNode with the given childNodes

Throws:

RuntimeException - if the given childNodes is null

RuntimeException - if one of the given childNodes is null

withChildNodes

public static ImmutableNode withChildNodes(String... childNodes)

Parameters:

childNodes -

Returns:

a new ImmutableNode with the given childNodes

Throws:

RuntimeException - if the given childNodes is null

RuntimeException - if one of the given childNodes does not represent a ImmutableNode.

withHeader

public static ImmutableNode withHeader(boolean header)

Parameters:

header -

Returns:

a new ImmutableNode with the given header.

withHeader

public static ImmutableNode withHeader(double header)

Parameters:

header -

Returns:

a new ImmutableNode with the given header.

withHeader

public static ImmutableNode withHeader(long header)

Parameters:

header -

Returns:

a new ImmutableNode with the given header.

withHeader

public static ImmutableNode withHeader(String header)

Parameters:

header -

Returns:

a new ImmutableNode with the given header

Throws:

RuntimeException - if the given header is null or blank

withHeaderAndChildNode

public static ImmutableNode withHeaderAndChildNode(String header,
 boolean childNode)

Parameters:

header -

childNode -

Returns:

a new ImmutableNode with the given childNode

Throws:

RuntimeException - if the given header is null or blank

withHeaderAndChildNode

public static ImmutableNode withHeaderAndChildNode(String header,
 double childNode)

Parameters:

header -

childNode -

Returns:

a new ImmutableNode with the given childNode. throws RuntimeException if the given header is null or blank

withHeaderAndChildNode

public static ImmutableNode withHeaderAndChildNode(String header,
 Node<?> childNode)

Parameters:

header -

childNode -

Returns:

a new ImmutableNode with the given header and childNode

Throws:

RuntimeException - if the given header is null or blank

RuntimeException - if the given childNode is null

withHeaderAndChildNode

public static ImmutableNode withHeaderAndChildNode(String header,
 long childNode)

Parameters:

header -

childNode -

Returns:

a new ImmutableNode with the given childNode. throws RuntimeException if the given header is null or blank

withHeaderAndChildNode

public static ImmutableNode withHeaderAndChildNode(String header,
 String childNode)

Parameters:

header -

childNode -

Returns:

a new ImmutableNode with the given header and childNode

Throws:

RuntimeException - if the given header is null or blank

RuntimeException - if the given childNode does not represent a ImmutableNode.

withHeaderAndChildNodes

public static ImmutableNode withHeaderAndChildNodes(String header,
 Node<?>... childNodes)

Parameters:

header -

childNodes -

Returns:

a new ImmutableNode 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

withHeaderAndChildNodes

public static ImmutableNode withHeaderAndChildNodes(String header,
 Iterable<? extends Node<?>> childNodes)

Parameters:

header -

childNodes -

Returns:

a new ImmutableNode 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

withHeaderAndChildNodes

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

Parameters:

header -

childNodes -

Returns:

a new ImmutableNode 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 does not represent a ImmutableNode.

getHeader

public String getHeader()

Returns:

the header of the current OptionalHeaderHolder

getStoredChildNodes

public ExtendedIterable<ImmutableNode> getStoredChildNodes()

Returns:

the child Nodes of the current Node

hasHeader

public boolean hasHeader()

Returns:

true if the current OptionalHeaderHolder has a header, false otherwise

withNewHeader

public Node<?> withNewHeader(String header)

Parameters:

header -

Returns:

a new Node from the current Node with the given new header