Class MutableNode

java.lang.Object

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

ch.nolix.base.document.node.AbstractMutableNode<MutableNode>

ch.nolix.base.document.node.MutableNode

All Implemented Interfaces:

FluentMutableOptionalHeaderHolder<MutableNode>, OptionalHeaderHolder, FormattedStringRepresentable, IMutableNode<MutableNode>, Node<MutableNode>, Resettable, BlanknessRequestable

public final class MutableNode
extends AbstractMutableNode<MutableNode>

Author:

Silvan Wyss

Field Summary

Fields inherited from interface FormattedStringRepresentable

DEFAULT_IDENTATION_LEVEL, DEFAULT_IDENTTATION_SYMBOL, DEFAULT_START_MULTILINER_WITH_IDENTATION_FLAG

Method Summary

Modifier and Type	Method	Description
MutableNode	addChildNode(Node<?> childNode)	Adds the given childNode to the current IMutableNode.
MutableNode	addChildNodes(Node<?>... childNodes)	Adds the given childNodes to the current IMutableNode.
<N extends Node<?>> MutableNode	addChildNodes(Iterable<N> pChildNodes)	Adds the given childNodes to the current IMutableNode.
MutableNode	addChildNodesFromStrings(Iterable<String> strings)	Adds the child Nodes from the given strings the current IMutableNode.
MutableNode	addChildNodesFromStrings(String... strings)	Adds the child Nodes from the given strings to the current IMutableNode.
static MutableNode	createEmpty()
static MutableNode	fromFile(String filePath)
static MutableNode	fromNode(Node<?> node)
static MutableNode	fromString(String string)
String	getHeader()
ExtendedIterable<MutableNode>	getStoredChildNodes()
boolean	hasHeader()
MutableNode	removeAndGetStoredFirstChildNodeThat(Predicate<Node<?>> selector)	Removes and returns the first child Node the given selector selects from the current IMutableNode.
void	removeChildNodes()	Removes the child Nodes from the current IMutableNode.
void	removeFirstChildNodeThat(Predicate<Node<?>> selector)	Removes the first child Node the given selector selects from the current IMutableNode.
void	removeFirstChildNodeWithHeader(String header)	Removes the first child Node with the given header from the current IMutableNode.
void	removeHeader()	Removes the header of current FluentMutableOptionalHeaderHolder.
void	replaceFirstChildNodeWithGivenHeaderByGivenNode(String header, Node<?> childNode)	Replaces the first child Node with the given header from the current IMutableNode by the given Node.
void	reset()	Resets the current Resettable.
MutableNode	setHeader(String header)	Sets the header of the current FluentMutableOptionalHeaderHolder.
Node<?>	withNewHeader(String header)

Methods inherited from class AbstractMutableNode

addPostfixToHeader, addPrefixToHeader, resetFromFile, resetFromNode, resetFromString, setChildNodes

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 BlanknessRequestable

isBlank

Methods inherited from interface FormattedStringRepresentable

formattedStringWillHaveMultipleLines, toFormattedString, toFormattedStringWithIndentationLevel, toFormattedStringWithIndentationLevelAndIndentationSymbol, toFormattedStringWithIndentationLevelAndIndentationSymbol

Methods inherited from interface Node

containsChildNode, containsChildNodes, containsChildNodeWithHeader, getChildNodeCount, getChildNodeCount, getChildNodesHeaders, getOptionalStoredFirstChildNode, getSingleChildNodeAsBoolean, getSingleChildNodeAsDouble, getSingleChildNodeAsInt, getSingleChildNodeHeader, getStoredChildNodeAtOneBasedIndex, getStoredChildNodes, getStoredChildNodesWithHeader, getStoredFirstChildNode, getStoredFirstChildNode, getStoredFirstChildNodeWithHeader, getStoredSingleChildNode, toBoolean, toDouble, toInt, toXml

Methods inherited from interface OptionalHeaderHolder

getHeaderOrEmptyString, getOptionalHeader, hasHeader

Method Details

createEmpty

public static MutableNode createEmpty()

Returns:

a new empty MutableNode.

fromFile

public static MutableNode fromFile(String filePath)

Parameters:

filePath -

Returns:

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

fromNode

public static MutableNode fromNode(Node<?> node)

Parameters:

node -

Returns:

a new MutableNode from the given Node.

fromString

public static MutableNode fromString(String string)

Parameters:

string -

Returns:

a new MutableNode from the given string

Throws:

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

addChildNode

public MutableNode addChildNode(Node<?> childNode)

Adds the given childNode to the current IMutableNode.

Parameters:

childNode -

Returns:

the current IMutableNode

addChildNodes

public MutableNode addChildNodes(Node<?>... childNodes)

Adds the given childNodes to the current IMutableNode.

Parameters:

childNodes -

Returns:

the current IMutableNode

addChildNodes

public <N extends Node<?>> MutableNode addChildNodes(Iterable<N> pChildNodes)

Adds the given childNodes to the current IMutableNode.

Type Parameters:

N - the type of the given childNodes

Parameters:

pChildNodes -

Returns:

the current IMutableNode

addChildNodesFromStrings

public MutableNode addChildNodesFromStrings(Iterable<String> strings)

Adds the child Nodes from the given strings the current IMutableNode.

Parameters:

strings -

Returns:

the current IMutableNode

addChildNodesFromStrings

public MutableNode addChildNodesFromStrings(String... strings)

Adds the child Nodes from the given strings to the current IMutableNode.

Parameters:

strings -

Returns:

the current IMutableNode

withNewHeader

public Node<?> withNewHeader(String header)

Parameters:

header -

Returns:

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

getStoredChildNodes

public ExtendedIterable<MutableNode> getStoredChildNodes()

Returns:

the child Nodes of the current Node

getHeader

public String getHeader()

Returns:

the header of the current OptionalHeaderHolder

hasHeader

public boolean hasHeader()

Returns:

true if the current OptionalHeaderHolder has a header, false otherwise

removeChildNodes

public void removeChildNodes()

Removes the child Nodes from the current IMutableNode.

removeAndGetStoredFirstChildNodeThat

public MutableNode removeAndGetStoredFirstChildNodeThat(Predicate<Node<?>> selector)

Removes and returns the first child Node the given selector selects from the current IMutableNode.

Parameters:

selector -

Returns:

the first child Node the given selector selects from the current IMutableNode

removeFirstChildNodeThat

public void removeFirstChildNodeThat(Predicate<Node<?>> selector)

Removes the first child Node the given selector selects from the current IMutableNode.

Parameters:

selector -

removeFirstChildNodeWithHeader

public void removeFirstChildNodeWithHeader(String header)

Removes the first child Node with the given header from the current IMutableNode.

Parameters:

header -

removeHeader

public void removeHeader()

Removes the header of current FluentMutableOptionalHeaderHolder.

replaceFirstChildNodeWithGivenHeaderByGivenNode

public void replaceFirstChildNodeWithGivenHeaderByGivenNode(String header,
 Node<?> childNode)

Replaces the first child Node with the given header from the current IMutableNode by the given Node.

Parameters:

header -

childNode -

reset

public void reset()

Resets the current Resettable.

setHeader

public MutableNode setHeader(String header)

Sets the header of the current FluentMutableOptionalHeaderHolder.

Parameters:

header -

Returns:

the current FluentMutableOptionalHeaderHolder