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:

IFluentMutableOptionalHeaderHolder<MutableNode>, IOptionalHeaderHolder, IMutableNode<MutableNode>, INode<MutableNode>, Resettable, BlanknessRequestable

public final class MutableNode
extends AbstractMutableNode<MutableNode>

Author:

Silvan Wyss

Field Summary

Fields inherited from class AbstractNode

CLOSED_BRACKET_CODE, COMMA_CODE, DOLLAR_SYMBOL_CODE, OPEN_BRACKET_CODE

Method Summary

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

Methods inherited from class AbstractMutableNode

addPostfixToHeader, addPrefixToHeader, resetFromFile, resetFromNode, resetFromString, setChildNodes

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 BlanknessRequestable

isBlank

Methods inherited from interface INode

containsChildNodes, containsChildNodeThat, containsChildNodeWithHeader, containsOneChildNode, getChildNodeCount, getChildNodeCount, getChildNodesHeaders, getOptionalStoredFirstChildNodeThat, getSingleChildNodeAsBoolean, getSingleChildNodeAsDouble, getSingleChildNodeAsInt, getSingleChildNodeHeader, getStoredChildNodeAtOneBasedIndex, getStoredChildNodesThat, getStoredChildNodesWithHeader, getStoredFirstChildNode, getStoredFirstChildNodeThat, getStoredFirstChildNodeWithHeader, getStoredSingleChildNode, toBoolean, toDouble, toFormattedString, toInt, toXml

Methods inherited from interface IOptionalHeaderHolder

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(INode<?> node)

Parameters:

node -

Returns:

a new MutableNode from the given INode.

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(INode<?> childNode)

Adds the given childNode to the current IMutableNode.

Parameters:

childNode -

Returns:

the current IMutableNode.

addChildNodes

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

Adds the given childNodes to the current IMutableNode.

Parameters:

childNodes -

Returns:

the current IMutableNode.

addChildNodes

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

Adds the given childNodes to the current IMutableNode.

Type Parameters:

N - is the type of the given childNodes.

Parameters:

pChildNodes -

Returns:

the current IMutableNode.

addChildNodesFromStrings

public MutableNode addChildNodesFromStrings(Iterable<String> strings)

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

Parameters:

strings -

Returns:

the current IMutableNode.

addChildNodesFromStrings

public MutableNode addChildNodesFromStrings(String... strings)

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

Parameters:

strings -

Returns:

the current IMutableNode.

asWithHeader

public INode<?> asWithHeader(String header)

Parameters:

header -

Returns:

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

getStoredChildNodes

public IContainer<MutableNode> getStoredChildNodes()

Returns:

the child INodes of the current INode.

getHeader

public String getHeader()

Returns:

the header of the current IOptionalHeaderHolder.

hasHeader

public boolean hasHeader()

Returns:

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

removeChildNodes

public void removeChildNodes()

Removes the child INodes from the current IMutableNode.

removeAndGetStoredFirstChildNodeThat

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

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

Parameters:

selector -

Returns:

the first child INode the given selector selects from the current IMutableNode.

removeFirstChildNodeThat

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

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

Parameters:

selector -

removeFirstChildNodeWithHeader

public void removeFirstChildNodeWithHeader(String header)

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

Parameters:

header -

removeHeader

public void removeHeader()

Removes the header of current IFluentMutableOptionalHeaderHolder.

replaceFirstChildNodeWithGivenHeaderByGivenNode

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

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

Parameters:

header -

childNode -

reset

public void reset()

Resets the current Resettable.

setHeader

public MutableNode setHeader(String header)

Sets the header of the current IFluentMutableOptionalHeaderHolder.

Parameters:

header -

Returns:

the current IFluentMutableOptionalHeaderHolder.