Interface IMutableNode<N extends IMutableNode<N>>

Type Parameters:

N - the type of a IMutableNode

All Superinterfaces:

BlanknessRequestable, FluentMutableOptionalHeaderHolder<N>, FormattedStringRepresentable, Node<N>, OptionalHeaderHolder, Resettable

All Known Implementing Classes:

AbstractMutableNode, FileNode, MutableNode

public interface IMutableNode<N extends IMutableNode<N>>
extends Node<N>, FluentMutableOptionalHeaderHolder<N>, Resettable

A IMutableNode is a Node that is mutable.

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
N	addChildNode(Node<?> childNode)	Adds the given childNode to the current IMutableNode.
N	addChildNodes(Node<?>... childNodes)	Adds the given childNodes to the current IMutableNode.
<N2 extends Node<?>> N	addChildNodes(Iterable<N2> childNodes)	Adds the given childNodes to the current IMutableNode.
N	addChildNodesFromStrings(Iterable<String> strings)	Adds the child Nodes from the given strings the current IMutableNode.
N	addChildNodesFromStrings(String... strings)	Adds the child Nodes 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<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	replaceFirstChildNodeWithGivenHeaderByGivenNode(String header, Node<?> node)	Replaces the first child Node with the given header from the current IMutableNode by the given Node.
void	resetFromFile(String filePath)	Resets the current IMutableNode from the file with the given file path.
void	resetFromNode(Node<?> 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 Node<?>> childNodes)	Resets the child Nodes of the current IMutableNode with the given childNodes.

Methods inherited from interface BlanknessRequestable

isBlank

Methods inherited from interface FluentMutableOptionalHeaderHolder

removeHeader, setHeader

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, getStoredChildNodes, getStoredChildNodesWithHeader, getStoredFirstChildNode, getStoredFirstChildNode, getStoredFirstChildNodeWithHeader, getStoredSingleChildNode, toBoolean, toDouble, toInt, toXml, withNewHeader

Methods inherited from interface OptionalHeaderHolder

getHeader, getHeaderOrEmptyString, getOptionalHeader, hasHeader, hasHeader

Methods inherited from interface Resettable

reset

Method Details

addChildNode

N addChildNode(Node<?> 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(Node<?>... 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 Node<?>> N addChildNodes(Iterable<N2> childNodes)

Adds the given childNodes to the current IMutableNode.

Type Parameters:

N2 - 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 Nodes 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 Node

addChildNodesFromStrings

N addChildNodesFromStrings(String... strings)

Adds the child Nodes 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 Node

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 or 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 or blank

removeAndGetStoredFirstChildNodeThat

N 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

Throws:

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

removeChildNodes

void removeChildNodes()

Removes the child Nodes from the current IMutableNode.

removeFirstChildNodeThat

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

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

Parameters:

selector -

Throws:

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

removeFirstChildNodeWithHeader

void removeFirstChildNodeWithHeader(String header)

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

Parameters:

header -

Throws:

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

replaceFirstChildNodeWithGivenHeaderByGivenNode

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

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

Parameters:

header -

node -

Throws:

RuntimeException - if the current IMutableNode does not contain a child Node 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(Node<?> 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 Node<?>> childNodes)

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

Parameters:

childNodes -

Returns:

the current IMutableNode

Throws:

RuntimeException - if one of the given childNodes is null