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:

IFluentMutableOptionalHeaderHolder<FileNode>, IOptionalHeaderHolder, IMutableNode<FileNode>, INode<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 class AbstractNode

CLOSED_BRACKET_CODE, COMMA_CODE, DOLLAR_SYMBOL_CODE, OPEN_BRACKET_CODE

Method Summary

Modifier and Type	Method	Description
FileNode	addChildNode(INode<?> childNode)	Adds the given childNode to the current IMutableNode.
FileNode	addChildNodes(INode<?>... childNodes)	Adds the given childNodes to the current IMutableNode.
<N extends INode<?>> FileNode	addChildNodes(Iterable<N> childNodes)	Adds the given childNodes to the current IMutableNode.
FileNode	addChildNodesFromStrings(Iterable<String> strings)	Adds the child INodes from the given strings the current IMutableNode.
FileNode	addChildNodesFromStrings(String... strings)	Adds the child INodes from the given strings to the current IMutableNode.
INode<?>	asWithHeader(String header)
String	getHeader()
ContainerView<FileNode>	getStoredChildNodes()
boolean	hasHeader()
FileNode	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<?> node)	Replaces the first child INode with the given header from the current IMutableNode by the given INode.
void	reset()	Resets the current Resettable.
FileNode	setHeader(String header)	Sets the header of the current IFluentMutableOptionalHeaderHolder.
static FileNode	withFilePath(String filePath)

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

withFilePath

public static FileNode withFilePath(String filePath)

addChildNode

public FileNode addChildNode(INode<?> childNode)

Adds the given childNode to the current IMutableNode.

Parameters:

childNode -

Returns:

the current IMutableNode.

addChildNodes

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

Adds the given childNodes to the current IMutableNode.

Parameters:

childNodes -

Returns:

the current IMutableNode.

addChildNodes

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

Adds the given childNodes to the current IMutableNode.

Type Parameters:

N - is the type of the given childNodes.

Parameters:

childNodes -

Returns:

the current IMutableNode.

addChildNodesFromStrings

public FileNode addChildNodesFromStrings(Iterable<String> strings)

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

Parameters:

strings -

Returns:

the current IMutableNode.

addChildNodesFromStrings

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

getHeader

public String getHeader()

Returns:

the header of the current IOptionalHeaderHolder.

getStoredChildNodes

public ContainerView<FileNode> getStoredChildNodes()

Returns:

the child INodes of the current INode.

hasHeader

public boolean hasHeader()

Returns:

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

removeAndGetStoredFirstChildNodeThat

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

removeChildNodes

public void removeChildNodes()

Removes the child INodes from the current IMutableNode.

removeHeader

public void removeHeader()

Removes the header of current IFluentMutableOptionalHeaderHolder.

replaceFirstChildNodeWithGivenHeaderByGivenNode

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

reset

public void reset()

Resets the current Resettable.

setHeader

public FileNode setHeader(String header)

Sets the header of the current IFluentMutableOptionalHeaderHolder.

Parameters:

header -

Returns:

the current IFluentMutableOptionalHeaderHolder.