com.phloc.commons.microdom.impl

Class AbstractMicroNodeWithChildren

java.lang.Object

com.phloc.commons.microdom.impl.AbstractMicroNode

com.phloc.commons.microdom.impl.AbstractMicroNodeWithChildren

All Implemented Interfaces:

ICloneable<IMicroNode>, IMicroNode, IMicroNodeWithChildren, IHasChildren<IMicroNode>, IHasChildrenSorted<IMicroNode>, IHasParent<IMicroNode>, Serializable

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractMicroNodeWithChildren()

Method Summary

Methods

Modifier and Type	Method and Description
List<IMicroNode>	getAllChildrenRecursive() Recursively get all children.
IMicroNode	getChildAtIndex(int nIndex) Get the child node at the specified index
int	getChildCount()
List<IMicroNode>	getChildren() Get a list of all direct child nodes.
IMicroNode	getFirstChild() Get the first child node or null if no child is present
IMicroNode	getLastChild() Get the last child node or null if no child is present
String	getTextContent() Get the concatenated text content of all direct IMicroText child nodes of this element.
String	getTextContentTrimmed() 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.
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 void	onInsertAfter(AbstractMicroNode aChildNode, IMicroNode aPredecessor) Callback that is invoked once a child is to be inserted after another child.
protected void	onInsertAtIndex(int nIndex, AbstractMicroNode aChildNode) Callback that is invoked once a child is to be inserted at the specified index.
protected void	onInsertBefore(AbstractMicroNode aChildNode, IMicroNode aSuccessor) Callback that is invoked once a child is to be inserted before another child.
protected EChange	onRemoveAllChildren() Remove all children from this node.
protected EChange	onRemoveChild(IMicroNode aChildNode) Callback when a child is removed.
protected EChange	onRemoveChildAtIndex(int nIndex) Remove the child not at the specified index.
String	toString()

Methods inherited from class com.phloc.commons.microdom.impl.AbstractMicroNode

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.phloc.commons.microdom.IMicroNodeWithChildren

getClone

Methods inherited from interface com.phloc.commons.microdom.IMicroNode

appendCDATA, appendCDATA, appendCDATA, appendCDATAWithConversion, appendChild, appendComment, appendComment, appendComment, appendCommentWithConversion, appendContainer, appendElement, appendElement, appendElement, appendElement, appendEntityReference, appendIgnorableWhitespaceText, appendIgnorableWhitespaceText, appendIgnorableWhitespaceText, appendProcessingInstruction, appendText, appendText, appendText, appendTextWithConversion, detachFromParent, 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

Constructor Detail

AbstractMicroNodeWithChildren

public AbstractMicroNodeWithChildren()

Method Detail

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

Specified by:

hasChildren in interface IHasChildren<IMicroNode>

Overrides:

hasChildren in class AbstractMicroNode

Returns:

true if at least one child is present, false otherwise

getChildren

@Nullable
@ReturnsMutableCopy
public final List<IMicroNode> getChildren()

Description copied from interface: IMicroNode

Get a list of all direct child nodes.

Specified by:

getChildren in interface IMicroNode

Specified by:

getChildren in interface IHasChildren<IMicroNode>

Specified by:

getChildren in interface IHasChildrenSorted<IMicroNode>

Overrides:

getChildren in class AbstractMicroNode

Returns:

May be null if the node has no children.

getChildAtIndex

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

Description copied from interface: IHasChildrenSorted

Get the child node at the specified index

Specified by:

getChildAtIndex in interface IHasChildrenSorted<IMicroNode>

Overrides:

getChildAtIndex in class AbstractMicroNode

Parameters:

nIndex - The index to be queried. May not be < 0 or ≥ the number of children

Returns:

The child at the specified index or null if the index is invalid.

getChildCount

public final int getChildCount()

Specified by:

getChildCount in interface IHasChildren<IMicroNode>

Overrides:

getChildCount in class AbstractMicroNode

Returns:

The number of contained direct children. Always ≥ 0.

getFirstChild

@Nullable
public final IMicroNode getFirstChild()

Description copied from interface: IHasChildrenSorted

Get the first child node or null if no child is present

Specified by:

getFirstChild in interface IMicroNode

Specified by:

getFirstChild in interface IHasChildrenSorted<IMicroNode>

Overrides:

getFirstChild in class AbstractMicroNode

Returns:

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

getLastChild

@Nullable
public final IMicroNode getLastChild()

Description copied from interface: IHasChildrenSorted

Get the last child node or null if no child is present

Specified by:

getLastChild in interface IMicroNode

Specified by:

getLastChild in interface IHasChildrenSorted<IMicroNode>

Overrides:

getLastChild in class AbstractMicroNode

Returns:

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

getAllChildrenRecursive

@Nonnull
@ReturnsMutableCopy
public final List<IMicroNode> getAllChildrenRecursive()

Description copied from interface: IMicroNode

Recursively get all children. Micro container are contained in this list (incl. their children of course)

Specified by:

getAllChildrenRecursive in interface IMicroNode

Overrides:

getAllChildrenRecursive in class AbstractMicroNode

Returns:

A list containing all recursively contained child elements. May be 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

getTextContentTrimmed

@Nullable
public String getTextContentTrimmed()

Description copied from interface: IMicroNodeWithChildren

Get the concatenated text content of all direct IMicroText child nodes of this element. After concatenation, all leading and trailing spaces are removed.

Specified by:

getTextContentTrimmed 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