Package com.helger.xml.microdom

Class AbstractMicroNodeWithChildren

java.lang.Object

com.helger.xml.microdom.AbstractMicroNode

com.helger.xml.microdom.AbstractMicroNodeWithChildren

All Implemented Interfaces:

com.helger.commons.hierarchy.IHasChildren<IMicroNode>, com.helger.commons.hierarchy.IHasChildrenRecursive<IMicroNode>, com.helger.commons.hierarchy.IHasChildrenSorted<IMicroNode>, com.helger.commons.hierarchy.IHasParent<IMicroNode>, com.helger.commons.lang.ICloneable<IMicroNode>, IMicroNode, IMicroNodeWithChildren

Direct Known Subclasses:

MicroContainer, MicroDocument, MicroElement

public abstract class AbstractMicroNodeWithChildren
extends AbstractMicroNode
implements IMicroNodeWithChildren

Basic implementation class for the micro document object model. It overrides all methods required for correct parent/child handling.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor	Description
AbstractMicroNodeWithChildren()

Method Summary

Modifier and Type	Method	Description
boolean	containsAnyChild(Predicate<? super IMicroNode> aFilter)	Check if any direct child matching the provided filter is contained.
protected final com.helger.commons.collection.impl.ICommonsList<IMicroNode>	directGetAllChildren()
final IMicroNode	findFirstChild(Predicate<? super IMicroNode> aFilter)
final <DSTTYPE> DSTTYPE	findFirstChildMapped(Predicate<? super IMicroNode> aFilter, Function<? super IMicroNode,? extends DSTTYPE> aMapper)
final void	forAllChildren(Consumer<? super IMicroNode> aConsumer)
final void	forAllChildren(Predicate<? super IMicroNode> aFilter, Consumer<? super IMicroNode> aConsumer)
com.helger.commons.state.EContinue	forAllChildrenBreakable(Function<? super IMicroNode,com.helger.commons.state.EContinue> aConsumer)
final <DSTTYPE> void	forAllChildrenMapped(Predicate<? super IMicroNode> aFilter, Function<? super IMicroNode,? extends DSTTYPE> aMapper, Consumer<? super DSTTYPE> aConsumer)
final com.helger.commons.collection.impl.ICommonsList<IMicroNode>	getAllChildren()	Get a list of all direct child nodes.
final IMicroNode	getChildAtIndex(int nIndex)
final int	getChildCount()
final com.helger.commons.collection.impl.ICommonsIterable<IMicroNode>	getChildren()
final IMicroNode	getFirstChild()
final IMicroNode	getLastChild()
String	getTextContent()	Get the concatenated text content of all direct IMicroText child nodes of this element.
<DSTTYPE> DSTTYPE	getTextContentWithConversion(Class<DSTTYPE> aDstClass)	Get the concatenated text content of all direct IMicroText child nodes of this element.
final boolean	hasChildren()
boolean	isEqualContent(IMicroNode o)	As instances of this class may not implement equals/hashCode we need a way to determine, if 2 nodes are equal by content.
protected void	onAppendChild(AbstractMicroNode aChildNode)	Callback that is invoked once a child is to be appended.
protected final void	onInsertAfter(AbstractMicroNode aChildNode, IMicroNode aPredecessor)	Callback that is invoked once a child is to be inserted after another child.
protected final void	onInsertAtIndex(int nIndex, AbstractMicroNode aChildNode)	Callback that is invoked once a child is to be inserted at the specified index.
protected final void	onInsertBefore(AbstractMicroNode aChildNode, IMicroNode aSuccessor)	Callback that is invoked once a child is to be inserted before another child.
protected final com.helger.commons.state.EChange	onRemoveAllChildren()	Remove all children from this node.
protected final com.helger.commons.state.EChange	onRemoveChild(IMicroNode aChildNode)	Callback when a child is removed.
protected final com.helger.commons.state.EChange	onRemoveChildAtIndex(int nIndex)	Remove the child not at the specified index.
String	toString()

Methods inherited from class com.helger.xml.microdom.AbstractMicroNode

appendChild, detachFromParent, findParentElement, getAllEventTargets, getAllEventTargets, getNextSibling, getParent, getPreviousSibling, hasParent, insertAfter, insertAtIndex, insertBefore, internalResetParentNode, internalSetParentNode, internalTriggerEvent, isCDATA, isComment, isContainer, isDocument, isDocumentType, isElement, isEntityReference, isProcessingInstruction, isText, onEvent, registerEventTarget, removeAllChildren, removeChild, removeChildAtIndex, unregisterEventTarget

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.commons.hierarchy.IHasChildren

hasNoChildren

Methods inherited from interface com.helger.commons.hierarchy.IHasChildrenRecursive

forAllChildrenRecursive, forAllChildrenRecursive

Methods inherited from interface com.helger.xml.microdom.IMicroNode

appendCDATA, appendCDATA, appendCDATA, appendCDATAWithConversion, appendChild, appendChildren, appendChildren, appendComment, appendComment, appendComment, appendCommentWithConversion, appendContainer, appendElement, appendElement, appendEntityReference, appendIgnorableWhitespaceText, appendIgnorableWhitespaceText, appendIgnorableWhitespaceText, appendProcessingInstruction, appendText, appendText, appendText, appendTextWithConversion, detachFromParent, findParentElement, getAllChildrenRecursive, getAllEventTargets, getAllEventTargets, getNextSibling, getNodeName, getNodeValue, getParent, getParentElementWithName, getParentElementWithName, getPreviousSibling, getType, hasParent, insertAfter, insertAtIndex, insertBefore, isCDATA, isComment, isContainer, isDocument, isDocumentType, isElement, isEntityReference, isProcessingInstruction, isText, registerEventTarget, removeAllChildren, removeChild, removeChildAtIndex, replaceChild, unregisterEventTarget

Methods inherited from interface com.helger.xml.microdom.IMicroNodeWithChildren

getClone, getTextContentTrimmed

Constructor Details

AbstractMicroNodeWithChildren

public AbstractMicroNodeWithChildren()

Method Details

directGetAllChildren

@Nullable
@ReturnsMutableObject("efficient access")
protected final com.helger.commons.collection.impl.ICommonsList<IMicroNode> directGetAllChildren()

Returns:

The writable list of all child nodes - handle with care. May be null.

onAppendChild

protected void onAppendChild(@Nonnull
 AbstractMicroNode aChildNode)

Description copied from class: AbstractMicroNode

Callback that is invoked once a child is to be appended.

Overrides:

onAppendChild in class AbstractMicroNode

Parameters:

aChildNode - The appended child node.

onInsertBefore

protected final void onInsertBefore(@Nonnull
 AbstractMicroNode aChildNode,
 @Nonnull
 IMicroNode aSuccessor)

Description copied from class: AbstractMicroNode

Callback that is invoked once a child is to be inserted before another child.

Overrides:

onInsertBefore in class AbstractMicroNode

Parameters:

aChildNode - The new child node to be inserted.

aSuccessor - The node before which the new node will be inserted.

onInsertAfter

protected final void onInsertAfter(@Nonnull
 AbstractMicroNode aChildNode,
 @Nonnull
 IMicroNode aPredecessor)

Description copied from class: AbstractMicroNode

Callback that is invoked once a child is to be inserted after another child.

Overrides:

onInsertAfter in class AbstractMicroNode

Parameters:

aChildNode - The new child node to be inserted.

aPredecessor - The node after which the new node will be inserted.

onInsertAtIndex

protected final void onInsertAtIndex(@Nonnegative
 int nIndex,
 @Nonnull
 AbstractMicroNode aChildNode)

Description copied from class: AbstractMicroNode

Callback that is invoked once a child is to be inserted at the specified index.

Overrides:

onInsertAtIndex in class AbstractMicroNode

Parameters:

nIndex - The index where the node should be inserted.

aChildNode - The new child node to be inserted.

onRemoveChild

@Nonnull
protected final com.helger.commons.state.EChange onRemoveChild(@Nonnull
 IMicroNode aChildNode)

Description copied from class: AbstractMicroNode

Callback when a child is removed.

Overrides:

onRemoveChild in class AbstractMicroNode

Parameters:

aChildNode - The child that is removed.

Returns:

EChange.CHANGED if something changed

onRemoveChildAtIndex

@Nonnull
protected final com.helger.commons.state.EChange onRemoveChildAtIndex(@Nonnegative
 int nIndex)

Description copied from class: AbstractMicroNode

Remove the child not at the specified index.

Overrides:

onRemoveChildAtIndex in class AbstractMicroNode

Parameters:

nIndex - The 0-based index of the item to be removed.

Returns:

EChange.CHANGED if the node was successfully removed, EChange.UNCHANGED otherwise.

onRemoveAllChildren

@Nonnull
protected final com.helger.commons.state.EChange onRemoveAllChildren()

Description copied from class: AbstractMicroNode

Remove all children from this node.

Overrides:

onRemoveAllChildren in class AbstractMicroNode

Returns:

EChange.CHANGED if at least one child was present, and was successfully removed, EChange.UNCHANGED otherwise.

hasChildren

public final boolean hasChildren()

Specified by:

hasChildren in interface com.helger.commons.hierarchy.IHasChildren<IMicroNode>

Overrides:

hasChildren in class AbstractMicroNode

getAllChildren

@Nullable
@ReturnsMutableCopy
public final com.helger.commons.collection.impl.ICommonsList<IMicroNode> getAllChildren()

Description copied from interface: IMicroNode

Get a list of all direct child nodes.

Specified by:

getAllChildren in interface com.helger.commons.hierarchy.IHasChildren<IMicroNode>

Specified by:

getAllChildren in interface com.helger.commons.hierarchy.IHasChildrenSorted<IMicroNode>

Specified by:

getAllChildren in interface IMicroNode

Overrides:

getAllChildren in class AbstractMicroNode

Returns:

May be null if the node has no children.

getChildren

@Nullable
public final com.helger.commons.collection.impl.ICommonsIterable<IMicroNode> getChildren()

Specified by:

getChildren in interface com.helger.commons.hierarchy.IHasChildren<IMicroNode>

Overrides:

getChildren in class AbstractMicroNode

forAllChildren

public final void forAllChildren(@Nonnull
 Consumer<? super IMicroNode> aConsumer)

Specified by:

forAllChildren in interface com.helger.commons.hierarchy.IHasChildren<IMicroNode>

Overrides:

forAllChildren in class AbstractMicroNode

forAllChildrenBreakable

@Nonnull
public com.helger.commons.state.EContinue forAllChildrenBreakable(@Nonnull
 Function<? super IMicroNode,com.helger.commons.state.EContinue> aConsumer)

Specified by:

forAllChildrenBreakable in interface com.helger.commons.hierarchy.IHasChildren<IMicroNode>

Overrides:

forAllChildrenBreakable in class AbstractMicroNode

forAllChildren

public final void forAllChildren(@Nonnull
 Predicate<? super IMicroNode> aFilter,
 @Nonnull
 Consumer<? super IMicroNode> aConsumer)

Specified by:

forAllChildren in interface com.helger.commons.hierarchy.IHasChildren<IMicroNode>

Overrides:

forAllChildren in class AbstractMicroNode

forAllChildrenMapped

public final <DSTTYPE> void forAllChildrenMapped(@Nonnull
 Predicate<? super IMicroNode> aFilter,
 @Nonnull
 Function<? super IMicroNode,? extends DSTTYPE> aMapper,
 @Nonnull
 Consumer<? super DSTTYPE> aConsumer)

Specified by:

forAllChildrenMapped in interface com.helger.commons.hierarchy.IHasChildren<IMicroNode>

Overrides:

forAllChildrenMapped in class AbstractMicroNode

containsAnyChild

public boolean containsAnyChild(@Nonnull
 Predicate<? super IMicroNode> aFilter)

Description copied from interface: IMicroNode

Check if any direct child matching the provided filter is contained.

Specified by:

containsAnyChild in interface IMicroNode

Parameters:

aFilter - The filter that is applied to all child nodes. May not be null.

Returns:

true if any child matching the provided filter is contained, false otherwise.

getChildAtIndex

@Nullable
public final IMicroNode getChildAtIndex(@Nonnegative
 int nIndex)

Specified by:

getChildAtIndex in interface com.helger.commons.hierarchy.IHasChildrenSorted<IMicroNode>

Overrides:

getChildAtIndex in class AbstractMicroNode

getChildCount

public final int getChildCount()

Specified by:

getChildCount in interface com.helger.commons.hierarchy.IHasChildren<IMicroNode>

Overrides:

getChildCount in class AbstractMicroNode

getFirstChild

@Nullable
public final IMicroNode getFirstChild()

Specified by:

getFirstChild in interface com.helger.commons.hierarchy.IHasChildrenSorted<IMicroNode>

Specified by:

getFirstChild in interface IMicroNode

Overrides:

getFirstChild in class AbstractMicroNode

Returns:

The first child node of this node, or null if this node has no children.

findFirstChild

@Nullable
public final IMicroNode findFirstChild(@Nonnull
 Predicate<? super IMicroNode> aFilter)

Specified by:

findFirstChild in interface com.helger.commons.hierarchy.IHasChildrenSorted<IMicroNode>

Overrides:

findFirstChild in class AbstractMicroNode

findFirstChildMapped

@Nullable
public final <DSTTYPE> DSTTYPE findFirstChildMapped(@Nonnull
 Predicate<? super IMicroNode> aFilter,
 @Nonnull
 Function<? super IMicroNode,? extends DSTTYPE> aMapper)

Specified by:

findFirstChildMapped in interface com.helger.commons.hierarchy.IHasChildrenSorted<IMicroNode>

Overrides:

findFirstChildMapped in class AbstractMicroNode

getLastChild

@Nullable
public final IMicroNode getLastChild()

Specified by:

getLastChild in interface com.helger.commons.hierarchy.IHasChildrenSorted<IMicroNode>

Specified by:

getLastChild in interface IMicroNode

Overrides:

getLastChild in class AbstractMicroNode

Returns:

The last child node of this node, or null if this node has no children.

getTextContent

@Nullable
public String getTextContent()

Description copied from interface: IMicroNodeWithChildren

Get the concatenated text content of all direct IMicroText child nodes of this element.

Specified by:

getTextContent in interface IMicroNodeWithChildren

Returns:

null if the element contains no text node as child

getTextContentWithConversion

@Nullable
public <DSTTYPE> DSTTYPE getTextContentWithConversion(@Nonnull
 Class<DSTTYPE> aDstClass)

Description copied from interface: IMicroNodeWithChildren

Get the concatenated text content of all direct IMicroText child nodes of this element. The value is converted via the TypeConverter to the desired destination class.

Specified by:

getTextContentWithConversion in interface IMicroNodeWithChildren

Type Parameters:

DSTTYPE - The destination type to convert the String textContent to.

Parameters:

aDstClass - The destination class to which the text content should be converted.

Returns:

null if the element contains no text node as child

isEqualContent

@OverridingMethodsMustInvokeSuper
public boolean isEqualContent(@Nullable
 IMicroNode o)

Description copied from interface: IMicroNode

As instances of this class may not implement equals/hashCode we need a way to determine, if 2 nodes are equal by content.

Specified by:

isEqualContent in interface IMicroNode

Parameters:

o - The node to compare to this.

Returns:

true if the nodes are of the same type and the same content, false otherwise.

toString

public String toString()

Overrides:

toString in class AbstractMicroNode