Class FileNode

java.lang.Object

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

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

ch.nolix.base.document.node.FileNode

All Implemented Interfaces:

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

public final class FileNode
extends AbstractMutableNode<FileNode>

A FileNode is a specification that is stored in a file.

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
FileNode	addChildNode(Node<?> childNode)	Adds the given childNode to the current IMutableNode.
FileNode	addChildNodes(Node<?>... childNodes)	Adds the given childNodes to the current IMutableNode.
<N extends Node<?>> FileNode	addChildNodes(Iterable<N> childNodes)	Adds the given childNodes to the current IMutableNode.
FileNode	addChildNodesFromStrings(Iterable<String> strings)	Adds the child Nodes from the given strings the current IMutableNode.
FileNode	addChildNodesFromStrings(String... strings)	Adds the child Nodes from the given strings to the current IMutableNode.
String	getHeader()
ExtendedIterableView<FileNode>	getStoredChildNodes()
boolean	hasHeader()
FileNode	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<?> node)	Replaces the first child Node with the given header from the current IMutableNode by the given Node.
void	reset()	Resets the current Resettable.
FileNode	setHeader(String header)	Sets the header of the current FluentMutableOptionalHeaderHolder.
static FileNode	withFilePath(String filePath)
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

withFilePath

public static FileNode withFilePath(String filePath)

addChildNode

public FileNode addChildNode(Node<?> childNode)

Adds the given childNode to the current IMutableNode.

Parameters:

childNode -

Returns:

the current IMutableNode

addChildNodes

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

Adds the given childNodes to the current IMutableNode.

Parameters:

childNodes -

Returns:

the current IMutableNode

addChildNodes

public <N extends Node<?>> FileNode addChildNodes(Iterable<N> childNodes)

Adds the given childNodes to the current IMutableNode.

Type Parameters:

N - the type of the given childNodes

Parameters:

childNodes -

Returns:

the current IMutableNode

addChildNodesFromStrings

public FileNode addChildNodesFromStrings(Iterable<String> strings)

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

Parameters:

strings -

Returns:

the current IMutableNode

addChildNodesFromStrings

public FileNode 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

getHeader

public String getHeader()

Returns:

the header of the current OptionalHeaderHolder

getStoredChildNodes

public ExtendedIterableView<FileNode> getStoredChildNodes()

Returns:

the child Nodes of the current Node

hasHeader

public boolean hasHeader()

Returns:

true if the current OptionalHeaderHolder has a header, false otherwise

removeAndGetStoredFirstChildNodeThat

public FileNode 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 -

removeChildNodes

public void removeChildNodes()

Removes the child Nodes from the current IMutableNode.

removeHeader

public void removeHeader()

Removes the header of current FluentMutableOptionalHeaderHolder.

replaceFirstChildNodeWithGivenHeaderByGivenNode

public 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 -

reset

public void reset()

Resets the current Resettable.

setHeader

public FileNode setHeader(String header)

Sets the header of the current FluentMutableOptionalHeaderHolder.

Parameters:

header -

Returns:

the current FluentMutableOptionalHeaderHolder