Class AbstractNode<N extends AbstractNode<N>>

java.lang.Object

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

Type Parameters:

N - the type of a AbstractNode.

All Implemented Interfaces:

OptionalHeaderHolder, FormattedStringRepresentable, Node<N>, BlanknessRequestable

Direct Known Subclasses:

AbstractMutableNode, ImmutableNode

public abstract class AbstractNode<N extends AbstractNode<N>>
extends Object
implements Node<N>

Author:

Silvan Wyss

Field Summary

Fields inherited from interface FormattedStringRepresentable

DEFAULT_IDENTATION_LEVEL, DEFAULT_IDENTTATION_SYMBOL, DEFAULT_START_MULTILINER_WITH_IDENTATION_FLAG

Constructor Summary

Constructors

Constructor	Description
AbstractNode()

Method Summary

Modifier and Type	Method	Description
final boolean	containsChildNode(Predicate<Node<?>> selector)
final boolean	containsChildNodes()
final boolean	containsChildNodeWithHeader(String header)
final boolean	equals(Object object)
final boolean	formattedStringWillHaveMultipleLines()
final int	getChildNodeCount()
final int	getChildNodeCount(Predicate<Node<?>> selector)
final ExtendedIterable<String>	getChildNodesHeaders()
static String	getEscapeStringFor(String string)
Optional<N>	getOptionalStoredFirstChildNode(Predicate<Node<?>> selector)
static String	getOriginStringFromEscapeString(String escapeString)
final boolean	getSingleChildNodeAsBoolean()
final double	getSingleChildNodeAsDouble()
final int	getSingleChildNodeAsInt()
final String	getSingleChildNodeHeader()
final N	getStoredChildNodeAtOneBasedIndex(int index)
final ExtendedIterable<N>	getStoredChildNodes(Predicate<Node<?>> selector)
final ExtendedIterable<N>	getStoredChildNodesWithHeader(String header)
final N	getStoredFirstChildNode()
final N	getStoredFirstChildNode(Predicate<Node<?>> selector)
final N	getStoredFirstChildNodeWithHeader(String header)
final N	getStoredSingleChildNode()
final int	hashCode()
final boolean	isBlank()
final void	saveToFile(String path)	Saves the current AbstractNode to the file with the given file path.
final void	saveToFile(String path, WriteMode writeMode)	Saves the current AbstractNode to the file with the given path.
final boolean	toBoolean()
final double	toDouble()
final String	toFormattedStringWithIndentationLevelAndIndentationSymbol(int indentationLevel, String indentationSymbol, boolean startMultiLinerWithIndentation)
final int	toInt()
final String	toString()
final IMutableXmlNode	toXml()

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface FormattedStringRepresentable

toFormattedString, toFormattedStringWithIndentationLevel, toFormattedStringWithIndentationLevelAndIndentationSymbol

Methods inherited from interface Node

getStoredChildNodes, withNewHeader

Methods inherited from interface OptionalHeaderHolder

getHeader, getHeaderOrEmptyString, getOptionalHeader, hasHeader, hasHeader

Constructor Details

AbstractNode

public AbstractNode()

Method Details

getEscapeStringFor

public static String getEscapeStringFor(String string)

Parameters:

string -

Returns:

an escape String for the given string.

getOriginStringFromEscapeString

public static String getOriginStringFromEscapeString(String escapeString)

Parameters:

escapeString -

Returns:

the origin String from the given escapeString

Throws:

NullPointerException - if the given escapeString is null

containsChildNodes

public final boolean containsChildNodes()

Specified by:

containsChildNodes in interface Node<N extends AbstractNode<N>>

Returns:

true if the current Node contains child Nodes, false otherwise

containsChildNode

public final boolean containsChildNode(Predicate<Node<?>> selector)

Specified by:

containsChildNode in interface Node<N extends AbstractNode<N>>

Parameters:

selector -

Returns:

true if the current Node contains a child Node the given selector selects, false otherwise

containsChildNodeWithHeader

public final boolean containsChildNodeWithHeader(String header)

Specified by:

containsChildNodeWithHeader in interface Node<N extends AbstractNode<N>>

Parameters:

header -

Returns:

true if the current Node contains a child Node with the given header, false otherwise

equals

public final boolean equals(Object object)

Overrides:

equals in class Object

formattedStringWillHaveMultipleLines

public final boolean formattedStringWillHaveMultipleLines()

Specified by:

formattedStringWillHaveMultipleLines in interface FormattedStringRepresentable

Returns:

true if a formatted String representation of the current FormattedStringRepresentable will have multiple lines, false otherwise

getChildNodeCount

public final int getChildNodeCount()

Specified by:

getChildNodeCount in interface Node<N extends AbstractNode<N>>

Returns:

the number of child Nodes of the current Node

getChildNodeCount

public final int getChildNodeCount(Predicate<Node<?>> selector)

Specified by:

getChildNodeCount in interface Node<N extends AbstractNode<N>>

Parameters:

selector -

Returns:

the number of child Nodes the given selector selects from the current Node

getChildNodesHeaders

public final ExtendedIterable<String> getChildNodesHeaders()

Specified by:

getChildNodesHeaders in interface Node<N extends AbstractNode<N>>

Returns:

the headers of the child Nodes of the current Node

getOptionalStoredFirstChildNode

public Optional<N> getOptionalStoredFirstChildNode(Predicate<Node<?>> selector)

Specified by:

getOptionalStoredFirstChildNode in interface Node<N extends AbstractNode<N>>

Parameters:

selector -

Returns:

a new Optional with the first child Node the given selector selects from the current Node, an empty Optional otherwise

getStoredChildNodeAtOneBasedIndex

public final N getStoredChildNodeAtOneBasedIndex(int index)

Specified by:

getStoredChildNodeAtOneBasedIndex in interface Node<N extends AbstractNode<N>>

Parameters:

index -

Returns:

the child Node at the given oneBasedIndex from the current Node

getStoredChildNodesWithHeader

public final ExtendedIterable<N> getStoredChildNodesWithHeader(String header)

Specified by:

getStoredChildNodesWithHeader in interface Node<N extends AbstractNode<N>>

Parameters:

header -

Returns:

the child Nodes with the given header from the current Node

getStoredChildNodes

public final ExtendedIterable<N> getStoredChildNodes(Predicate<Node<?>> selector)

Specified by:

getStoredChildNodes in interface Node<N extends AbstractNode<N>>

Parameters:

selector -

Returns:

the child Nodes the given selector selects from the current Node

getStoredFirstChildNode

public final N getStoredFirstChildNode()

Specified by:

getStoredFirstChildNode in interface Node<N extends AbstractNode<N>>

Returns:

the first child Node from the current Node

getStoredSingleChildNode

public final N getStoredSingleChildNode()

Specified by:

getStoredSingleChildNode in interface Node<N extends AbstractNode<N>>

Returns:

the single child Node of the current Node

getStoredFirstChildNode

public final N getStoredFirstChildNode(Predicate<Node<?>> selector)

Specified by:

getStoredFirstChildNode in interface Node<N extends AbstractNode<N>>

Parameters:

selector -

Returns:

the first child Node the given selector selects from the current Node

getStoredFirstChildNodeWithHeader

public final N getStoredFirstChildNodeWithHeader(String header)

Specified by:

getStoredFirstChildNodeWithHeader in interface Node<N extends AbstractNode<N>>

Parameters:

header -

Returns:

the first child Node with the given header from the current Node

getSingleChildNodeAsBoolean

public final boolean getSingleChildNodeAsBoolean()

Specified by:

getSingleChildNodeAsBoolean in interface Node<N extends AbstractNode<N>>

Returns:

the boolean the single child Node of the current Node represents

getSingleChildNodeAsDouble

public final double getSingleChildNodeAsDouble()

Specified by:

getSingleChildNodeAsDouble in interface Node<N extends AbstractNode<N>>

Returns:

the double the single child Node of the current Node represents

getSingleChildNodeAsInt

public final int getSingleChildNodeAsInt()

Specified by:

getSingleChildNodeAsInt in interface Node<N extends AbstractNode<N>>

Returns:

the int the single child Node of the current Node represents

getSingleChildNodeHeader

public final String getSingleChildNodeHeader()

Specified by:

getSingleChildNodeHeader in interface Node<N extends AbstractNode<N>>

Returns:

the header of the single child Node of the current Node

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

isBlank

public final boolean isBlank()

Specified by:

isBlank in interface BlanknessRequestable

Returns:

true if BlanknessRequestable is blank, false otherwise

saveToFile

public final void saveToFile(String path)

Saves the current AbstractNode to the file with the given file path.

Parameters:

path -

Throws:

RuntimeException - if the given path is null

RuntimeException - if the given path is blank

RuntimeException - if there exists already a file system item with the given path.

saveToFile

public final void saveToFile(String path,
 WriteMode writeMode)

Saves the current AbstractNode to the file with the given path.

Parameters:

path -

writeMode -

Throws:

RuntimeException - if the given path is null

RuntimeException - if the given path is blank

RuntimeException - if the given writeMode flag=WriteMode.THROW_EXCEPTION_WHEN_TARGET_EXISTS_ALREADY and there exists already a file system item with the given path.

toBoolean

public final boolean toBoolean()

Specified by:

toBoolean in interface Node<N extends AbstractNode<N>>

Returns:

the boolean the current Node represents

toDouble

public final double toDouble()

Specified by:

toDouble in interface Node<N extends AbstractNode<N>>

Returns:

the double the current Node represents

toFormattedStringWithIndentationLevelAndIndentationSymbol

public final String toFormattedStringWithIndentationLevelAndIndentationSymbol(int indentationLevel,
 String indentationSymbol,
 boolean startMultiLinerWithIndentation)

Specified by:

toFormattedStringWithIndentationLevelAndIndentationSymbol in interface FormattedStringRepresentable

Parameters:

indentationLevel -

indentationSymbol -

startMultiLinerWithIndentation -

Returns:

a formatted String representation of the current FormattedStringRepresentable with the given indentationLevel and indentationSymbol

toInt

public final int toInt()

Specified by:

toInt in interface Node<N extends AbstractNode<N>>

Returns:

the int the current Node represents

toString

public final String toString()

Overrides:

toString in class Object

toXml

public final IMutableXmlNode toXml()

Specified by:

toXml in interface Node<N extends AbstractNode<N>>

Returns:

a IXmlNode representation of the current Node