Class AbstractNode<N extends AbstractNode<N>>

java.lang.Object

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

Type Parameters:

N - is the type of a AbstractNode.

All Implemented Interfaces:

IOptionalHeaderHolder, INode<N>, BlanknessRequestable

Direct Known Subclasses:

AbstractMutableNode, Node

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

Author:

Silvan Wyss

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CLOSED_BRACKET_CODE
static final String	COMMA_CODE
static final String	DOLLAR_SYMBOL_CODE
static final String	OPEN_BRACKET_CODE

Constructor Summary

Constructors

Constructor	Description
AbstractNode()

Method Summary

Modifier and Type	Method	Description
final boolean	containsChildNodes()
final boolean	containsChildNodeThat(Predicate<INode<?>> selector)
final boolean	containsChildNodeWithHeader(String header)
final boolean	containsOneChildNode()
final boolean	equals(Object object)
final int	getChildNodeCount()
final int	getChildNodeCount(Predicate<INode<?>> selector)
final IContainer<String>	getChildNodesHeaders()
static String	getEscapeStringFor(String string)
Optional<N>	getOptionalStoredFirstChildNodeThat(Predicate<INode<?>> selector)
static String	getOriginStringFromEscapeString(String escapeString)
final boolean	getSingleChildNodeAsBoolean()
final double	getSingleChildNodeAsDouble()
final int	getSingleChildNodeAsInt()
final String	getSingleChildNodeHeader()
final N	getStoredChildNodeAtOneBasedIndex(int index)
final IContainer<N>	getStoredChildNodesThat(Predicate<INode<?>> selector)
final IContainer<N>	getStoredChildNodesWithHeader(String header)
final N	getStoredFirstChildNode()
final N	getStoredFirstChildNodeThat(Predicate<INode<?>> 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	toFormattedString()
final int	toInt()
final String	toString()
final IMutableXmlNode	toXml()

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface INode

asWithHeader, getStoredChildNodes

Methods inherited from interface IOptionalHeaderHolder

getHeader, getHeaderOrEmptyString, getOptionalHeader, hasHeader, hasHeader

Field Details

COMMA_CODE

public static final String COMMA_CODE

See Also:

• Constant Field Values

DOLLAR_SYMBOL_CODE

public static final String DOLLAR_SYMBOL_CODE

See Also:

• Constant Field Values

OPEN_BRACKET_CODE

public static final String OPEN_BRACKET_CODE

See Also:

• Constant Field Values

CLOSED_BRACKET_CODE

public static final String CLOSED_BRACKET_CODE

See Also:

• Constant Field Values

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 INode<N extends AbstractNode<N>>

Returns:

true if the current INode contains child INodes, false otherwise.

containsChildNodeThat

public final boolean containsChildNodeThat(Predicate<INode<?>> selector)

Specified by:

containsChildNodeThat in interface INode<N extends AbstractNode<N>>

Parameters:

selector -

Returns:

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

containsChildNodeWithHeader

public final boolean containsChildNodeWithHeader(String header)

Specified by:

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

Parameters:

header -

Returns:

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

containsOneChildNode

public final boolean containsOneChildNode()

Specified by:

containsOneChildNode in interface INode<N extends AbstractNode<N>>

Returns:

true if the current INode contains 1 child INode, false otherwise.

equals

public final boolean equals(Object object)

Overrides:

equals in class Object

getChildNodeCount

public final int getChildNodeCount()

Specified by:

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

Returns:

the number of child INodes of the current INode.

getChildNodeCount

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

Specified by:

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

Parameters:

selector -

Returns:

the number of child INodes the given selector selects from the current INode.

getChildNodesHeaders

public final IContainer<String> getChildNodesHeaders()

Specified by:

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

Returns:

the headers of the child INodes of the current INode.

getOptionalStoredFirstChildNodeThat

public Optional<N> getOptionalStoredFirstChildNodeThat(Predicate<INode<?>> selector)

Specified by:

getOptionalStoredFirstChildNodeThat in interface INode<N extends AbstractNode<N>>

Parameters:

selector -

Returns:

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

getStoredChildNodeAtOneBasedIndex

public final N getStoredChildNodeAtOneBasedIndex(int index)

Specified by:

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

Parameters:

index -

Returns:

the child INode at the given oneBasedIndex from the current INode.

getStoredChildNodesWithHeader

public final IContainer<N> getStoredChildNodesWithHeader(String header)

Specified by:

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

Parameters:

header -

Returns:

the child INodes with the given header from the current INode.

getStoredChildNodesThat

public final IContainer<N> getStoredChildNodesThat(Predicate<INode<?>> selector)

Specified by:

getStoredChildNodesThat in interface INode<N extends AbstractNode<N>>

Parameters:

selector -

Returns:

the child INodes the given selector selects from the current INode.

getStoredFirstChildNode

public final N getStoredFirstChildNode()

Specified by:

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

Returns:

the first child INode from the current INode.

getStoredSingleChildNode

public final N getStoredSingleChildNode()

Specified by:

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

Returns:

the single child INode of the current INode.

getStoredFirstChildNodeThat

public final N getStoredFirstChildNodeThat(Predicate<INode<?>> selector)

Specified by:

getStoredFirstChildNodeThat in interface INode<N extends AbstractNode<N>>

Parameters:

selector -

Returns:

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

getStoredFirstChildNodeWithHeader

public final N getStoredFirstChildNodeWithHeader(String header)

Specified by:

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

Parameters:

header -

Returns:

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

getSingleChildNodeAsBoolean

public final boolean getSingleChildNodeAsBoolean()

Specified by:

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

Returns:

the boolean the single child INode of the current INode represents.

getSingleChildNodeAsDouble

public final double getSingleChildNodeAsDouble()

Specified by:

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

Returns:

the double the single child INode of the current INode represents.

getSingleChildNodeAsInt

public final int getSingleChildNodeAsInt()

Specified by:

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

Returns:

the int the single child INode of the current INode represents.

getSingleChildNodeHeader

public final String getSingleChildNodeHeader()

Specified by:

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

Returns:

the header of the single child INode of the current INode.

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 INode<N extends AbstractNode<N>>

Returns:

the boolean the current INode represents.

toDouble

public final double toDouble()

Specified by:

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

Returns:

the double the current INode represents.

toFormattedString

public final String toFormattedString()

Specified by:

toFormattedString in interface INode<N extends AbstractNode<N>>

Returns:

a formatted String representation of the current INode.

toInt

public final int toInt()

Specified by:

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

Returns:

the int the current INode represents.

toString

public final String toString()

Overrides:

toString in class Object

toXml

public final IMutableXmlNode toXml()

Specified by:

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

Returns:

a IXmlNode representation of the current INode.