Package ch.nolix.core.document.node

Klasse BaseNode<BN extends BaseNode<BN>>

java.lang.Object

ch.nolix.core.document.node.BaseNode<BN>

Typparameter:

BN - is the type of a BaseNode.

Alle implementierten Schnittstellen:

IOptionalHeaderHolder, INode<BN>, BlanknessRequestable

Bekannte direkte Unterklassen:

BaseMutableNode, Node

public abstract class BaseNode<BN extends BaseNode<BN>>
extends Object
implements INode<BN>

Version:

2017-06-24

Autor:

Silvan Wyss

Feldübersicht

Felder

Modifizierer und Typ	Feld	Beschreibung
static final String	CLOSED_BRACKET_CODE
static final String	COMMA_CODE
static final String	DOLLAR_SYMBOL_CODE
static final String	OPEN_BRACKET_CODE

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
BaseNode()

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
final boolean	containsChildNodes()
final boolean	containsChildNodeThat(Predicate<INode<?>> selector)
final boolean	containsChildNodeWithHeader(String header)
final boolean	containsOneChildNode()
protected final boolean	equalsNode(BaseNode<?> node)
final int	getChildNodeCount()
final IContainer<String>	getChildNodesHeaders()
static String	getEscapeStringFor(String string)
Optional<BN>	getOptionalStoredFirstChildNodeThat(Predicate<INode<?>> selector)
static String	getOriginStringFromEscapeString(String escapeString)
final boolean	getSingleChildNodeAsBoolean()
final double	getSingleChildNodeAsDouble()
final int	getSingleChildNodeAsInt()
final String	getSingleChildNodeHeader()
final BN	getStoredChildNodeAt1BasedIndex(int index)
final IContainer<BN>	getStoredChildNodesThat(Predicate<INode<?>> selector)
final IContainer<BN>	getStoredChildNodesWithHeader(String header)
final BN	getStoredFirstChildNode()
final BN	getStoredFirstChildNodeThat(Predicate<INode<?>> selector)
final BN	getStoredFirstChildNodeWithHeader(String header)
final BN	getStoredSingleChildNode()
final boolean	isBlank()
final void	saveToFile(String path)	Saves the current BaseNode to the file with the given file path.
final void	saveToFile(String path, WriteMode writeMode)	Saves the current BaseNode 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()

Von Klasse geerbte Methoden java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Von Schnittstelle geerbte Methoden ch.nolix.coreapi.documentapi.nodeapi.INode

asWithHeader, getStoredChildNodes

Von Schnittstelle geerbte Methoden ch.nolix.coreapi.attributeapi.optionalattributeapi.IOptionalHeaderHolder

getHeader, getHeaderOrEmptyString, getOptionalHeader, hasHeader, hasHeader

Felddetails

COMMA_CODE

public static final String COMMA_CODE

Siehe auch:

• Konstantenfeldwerte

DOLLAR_SYMBOL_CODE

public static final String DOLLAR_SYMBOL_CODE

Siehe auch:

• Konstantenfeldwerte

OPEN_BRACKET_CODE

public static final String OPEN_BRACKET_CODE

Siehe auch:

• Konstantenfeldwerte

CLOSED_BRACKET_CODE

public static final String CLOSED_BRACKET_CODE

Siehe auch:

• Konstantenfeldwerte

Konstruktordetails

BaseNode

public BaseNode()

Methodendetails

getEscapeStringFor

public static String getEscapeStringFor(String string)

Parameter:

string -

Gibt zurück:

an escape String for the given string.

getOriginStringFromEscapeString

public static String getOriginStringFromEscapeString(String escapeString)

Parameter:

escapeString -

Gibt zurück:

the origin String from the given escapeString.

Löst aus:

NullPointerException - if the given escapeString is null.

containsChildNodes

public final boolean containsChildNodes()

Angegeben von:

containsChildNodes in Schnittstelle INode<BN extends BaseNode<BN>>

Gibt zurück:

true if the current INode contains child INodes.

containsChildNodeThat

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

Angegeben von:

containsChildNodeThat in Schnittstelle INode<BN extends BaseNode<BN>>

Parameter:

selector -

Gibt zurück:

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

containsChildNodeWithHeader

public final boolean containsChildNodeWithHeader(String header)

Angegeben von:

containsChildNodeWithHeader in Schnittstelle INode<BN extends BaseNode<BN>>

Parameter:

header -

Gibt zurück:

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

containsOneChildNode

public final boolean containsOneChildNode()

Angegeben von:

containsOneChildNode in Schnittstelle INode<BN extends BaseNode<BN>>

Gibt zurück:

true if the current INode contains 1 child INode.

getChildNodeCount

public final int getChildNodeCount()

Angegeben von:

getChildNodeCount in Schnittstelle INode<BN extends BaseNode<BN>>

Gibt zurück:

the number of child INodes of the current INode.

getChildNodesHeaders

public final IContainer<String> getChildNodesHeaders()

Angegeben von:

getChildNodesHeaders in Schnittstelle INode<BN extends BaseNode<BN>>

Gibt zurück:

the headers of the child INodes of the current INode.

getOptionalStoredFirstChildNodeThat

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

Angegeben von:

getOptionalStoredFirstChildNodeThat in Schnittstelle INode<BN extends BaseNode<BN>>

Parameter:

selector -

Gibt zurück:

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

getStoredChildNodeAt1BasedIndex

public final BN getStoredChildNodeAt1BasedIndex(int index)

Angegeben von:

getStoredChildNodeAt1BasedIndex in Schnittstelle INode<BN extends BaseNode<BN>>

Parameter:

index -

Gibt zurück:

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

getStoredChildNodesWithHeader

public final IContainer<BN> getStoredChildNodesWithHeader(String header)

Angegeben von:

getStoredChildNodesWithHeader in Schnittstelle INode<BN extends BaseNode<BN>>

Parameter:

header -

Gibt zurück:

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

getStoredChildNodesThat

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

Angegeben von:

getStoredChildNodesThat in Schnittstelle INode<BN extends BaseNode<BN>>

Parameter:

selector -

Gibt zurück:

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

getStoredFirstChildNode

public final BN getStoredFirstChildNode()

Angegeben von:

getStoredFirstChildNode in Schnittstelle INode<BN extends BaseNode<BN>>

Gibt zurück:

the first child INode from the current INode.

getStoredSingleChildNode

public final BN getStoredSingleChildNode()

Angegeben von:

getStoredSingleChildNode in Schnittstelle INode<BN extends BaseNode<BN>>

Gibt zurück:

the single child INode of the current INode.

getStoredFirstChildNodeThat

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

Angegeben von:

getStoredFirstChildNodeThat in Schnittstelle INode<BN extends BaseNode<BN>>

Parameter:

selector -

Gibt zurück:

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

getStoredFirstChildNodeWithHeader

public final BN getStoredFirstChildNodeWithHeader(String header)

Angegeben von:

getStoredFirstChildNodeWithHeader in Schnittstelle INode<BN extends BaseNode<BN>>

Parameter:

header -

Gibt zurück:

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

getSingleChildNodeAsBoolean

public final boolean getSingleChildNodeAsBoolean()

Angegeben von:

getSingleChildNodeAsBoolean in Schnittstelle INode<BN extends BaseNode<BN>>

Gibt zurück:

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

getSingleChildNodeAsDouble

public final double getSingleChildNodeAsDouble()

Angegeben von:

getSingleChildNodeAsDouble in Schnittstelle INode<BN extends BaseNode<BN>>

Gibt zurück:

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

getSingleChildNodeAsInt

public final int getSingleChildNodeAsInt()

Angegeben von:

getSingleChildNodeAsInt in Schnittstelle INode<BN extends BaseNode<BN>>

Gibt zurück:

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

getSingleChildNodeHeader

public final String getSingleChildNodeHeader()

Angegeben von:

getSingleChildNodeHeader in Schnittstelle INode<BN extends BaseNode<BN>>

Gibt zurück:

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

isBlank

public final boolean isBlank()

Angegeben von:

isBlank in Schnittstelle BlanknessRequestable

Gibt zurück:

true if BlanknessRequestable is blank.

saveToFile

public final void saveToFile(String path)

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

Parameter:

path -

Löst aus:

ArgumentIsNullException - if the given path is null.

InvalidArgumentException - if the given path is blank.

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

saveToFile

public final void saveToFile(String path,
 WriteMode writeMode)

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

Parameter:

path -

writeMode -

Löst aus:

ArgumentIsNullException - if the given path is null.

InvalidArgumentException - if the given path is blank.

InvalidArgumentException - 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()

Angegeben von:

toBoolean in Schnittstelle INode<BN extends BaseNode<BN>>

Gibt zurück:

the boolean the current INode represents.

toDouble

public final double toDouble()

Angegeben von:

toDouble in Schnittstelle INode<BN extends BaseNode<BN>>

Gibt zurück:

the double the current INode represents.

toFormattedString

public final String toFormattedString()

Angegeben von:

toFormattedString in Schnittstelle INode<BN extends BaseNode<BN>>

Gibt zurück:

a formatted String representation of the current INode.

toInt

public final int toInt()

Angegeben von:

toInt in Schnittstelle INode<BN extends BaseNode<BN>>

Gibt zurück:

the int the current INode represents.

toString

public final String toString()

Setzt außer Kraft:

toString in Klasse Object

toXml

public final IMutableXmlNode toXml()

Angegeben von:

toXml in Schnittstelle INode<BN extends BaseNode<BN>>

Gibt zurück:

a IXmlNode representation of the current INode.

equalsNode

protected final boolean equalsNode(BaseNode<?> node)

Parameter:

node -

Gibt zurück:

true if the current BaseNode equals the given node.