Interface IMutableNode<N extends IMutableNode<N>>

Type Parameters:

N - is the type of a IMutableNode.

All Superinterfaces:

BlanknessRequestable, IFluentMutableOptionalHeaderHolder<N>, INode<N>, IOptionalHeaderHolder, Resettable

All Known Implementing Classes:

AbstractMutableNode, FileNode, MutableNode

public interface IMutableNode<N extends IMutableNode<N>>
extends INode<N>, IFluentMutableOptionalHeaderHolder<N>, Resettable

A IMutableNode is a INode that is mutable.

Author:

Silvan Wyss

Method Summary

Modifier and Type	Method	Description
N	addChildNode(INode<?> childNode)	Adds the given childNode to the current IMutableNode.
N	addChildNodes(INode<?>... childNodes)	Adds the given childNodes to the current IMutableNode.
<N2 extends INode<?>> N	addChildNodes(Iterable<N2> childNodes)	Adds the given childNodes to the current IMutableNode.
N	addChildNodesFromStrings(Iterable<String> strings)	Adds the child INodes from the given strings the current IMutableNode.
N	addChildNodesFromStrings(String... strings)	Adds the child INodes from the given strings to the current IMutableNode.
N	addPostfixToHeader(String postfix)	Adds the given postfix at the end of the header of the current IMutableNode if the current IMutableNode has a header.
N	addPrefixToHeader(String prefix)	Adds the given prefix at the begin of the header of the current IMutableNode if the current IMutableNode has a header.
N	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	replaceFirstChildNodeWithGivenHeaderByGivenNode(String header, INode<?> node)	Replaces the first child INode with the given header from the current IMutableNode by the given INode.
void	resetFromFile(String filePath)	Resets the current IMutableNode from the file with the given file path.
void	resetFromNode(INode<?> node)	Resets the current IMutableNode from the given node.
void	resetFromString(String string)	Resets the current IMutableNode from the given string.
N	setChildNodes(Iterable<? extends INode<?>> childNodes)	Resets the child INodes of the current IMutableNode with the given childNodes.

Methods inherited from interface BlanknessRequestable

isBlank

Methods inherited from interface IFluentMutableOptionalHeaderHolder

removeHeader, setHeader

Methods inherited from interface INode

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

Methods inherited from interface IOptionalHeaderHolder

getHeader, getHeaderOrEmptyString, getOptionalHeader, hasHeader, hasHeader

Methods inherited from interface Resettable

reset

Method Details

addChildNode

N addChildNode(INode<?> childNode)

Adds the given childNode to the current IMutableNode.

Parameters:

childNode -

Returns:

the current IMutableNode.

Throws:

RuntimeException - if the given childNodes is null.

addChildNodes

N addChildNodes(INode<?>... childNodes)

Adds the given childNodes to the current IMutableNode.

Parameters:

childNodes -

Returns:

the current IMutableNode.

Throws:

RuntimeException - if one of the given childNodes is null.

addChildNodes

<N2 extends INode<?>> N addChildNodes(Iterable<N2> childNodes)

Adds the given childNodes to the current IMutableNode.

Type Parameters:

N2 - is the type of the given childNodes.

Parameters:

childNodes -

Returns:

the current IMutableNode.

Throws:

RuntimeException - if one of the given childNodes is null.

addChildNodesFromStrings

N addChildNodesFromStrings(Iterable<String> strings)

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

Parameters:

strings -

Returns:

the current IMutableNode.

Throws:

RuntimeException - if one of the given strings does not represent a INode.

addChildNodesFromStrings

N addChildNodesFromStrings(String... strings)

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

Parameters:

strings -

Returns:

the current IMutableNode.

Throws:

RuntimeException - if the given strings is null.

RuntimeException - if one of the given strings does not represent a INode.

addPostfixToHeader

N addPostfixToHeader(String postfix)

Adds the given postfix at the end of the header of the current IMutableNode if the current IMutableNode has a header. Sets the given postfix as the header of the current IMutableNode if the current IMutableNode does not have a header.

Parameters:

postfix -

Returns:

the current IMutableNode.

Throws:

RuntimeException - if the given postfix is null.

RuntimeException - if the given postfix is blank.

addPrefixToHeader

N addPrefixToHeader(String prefix)

Adds the given prefix at the begin of the header of the current IMutableNode if the current IMutableNode has a header. Sets the given prefix as the header of the current IMutableNode if the current IMutableNode does not have a header.

Parameters:

prefix -

Returns:

the current IMutableNode.

Throws:

RuntimeException - if the given prefix is null.

RuntimeException - if the given prefix is blank.

removeAndGetStoredFirstChildNodeThat

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

Throws:

RuntimeException - if the current IMutableNode does not contain a child INode the given selector selects.

removeChildNodes

void removeChildNodes()

Removes the child INodes from the current IMutableNode.

removeFirstChildNodeThat

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

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

Parameters:

selector -

Throws:

RuntimeException - if the current IMutableNode does not contain a child INode the given selector selects.

removeFirstChildNodeWithHeader

void removeFirstChildNodeWithHeader(String header)

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

Parameters:

header -

Throws:

RuntimeException - if the current IMutableNode does not contain a child INode with the given header.

replaceFirstChildNodeWithGivenHeaderByGivenNode

void replaceFirstChildNodeWithGivenHeaderByGivenNode(String header,
 INode<?> node)

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

Parameters:

header -

node -

Throws:

RuntimeException - if the current IMutableNode does not contain a child INode with the given header.

resetFromFile

void resetFromFile(String filePath)

Resets the current IMutableNode from the file with the given file path.

Parameters:

filePath -

resetFromNode

void resetFromNode(INode<?> node)

Resets the current IMutableNode from the given node.

Parameters:

node -

Throws:

RuntimeException - if the given node is null.

resetFromString

void resetFromString(String string)

Resets the current IMutableNode from the given string.

Parameters:

string -

Throws:

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

setChildNodes

N setChildNodes(Iterable<? extends INode<?>> childNodes)

Resets the child INodes of the current IMutableNode with the given childNodes.

Parameters:

childNodes -

Returns:

the current IMutableNode.

Throws:

RuntimeException - if one of the given childNodes is null.