Package com.helger.xml.microdom

Class MicroDocument

java.lang.Object

com.helger.xml.microdom.AbstractMicroNode

com.helger.xml.microdom.AbstractMicroNodeWithChildren

com.helger.xml.microdom.MicroDocument

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>, IMicroDocument, IMicroNode, IMicroNodeWithChildren

public final class MicroDocument
extends AbstractMicroNodeWithChildren
implements IMicroDocument

Default implementation of the IMicroDocument interface.

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field	Description
static final com.helger.commons.state.ETriState	DEFAULT_STANDALONE

Constructor Summary

Constructors

Constructor	Description
MicroDocument()
MicroDocument(IMicroDocumentType aDocType)

Method Summary

Modifier and Type	Method	Description
IMicroDocument	getClone()
IMicroDocumentType	getDocType()
IMicroElement	getDocumentElement()
String	getNodeName()
com.helger.commons.state.ETriState	getStandalone()
EMicroNodeType	getType()
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.
void	setStandalone(com.helger.commons.state.ETriState eStandalone)	Change the standalone state of this document.
String	toString()

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

containsAnyChild, directGetAllChildren, findFirstChild, findFirstChildMapped, forAllChildren, forAllChildren, forAllChildrenBreakable, forAllChildrenMapped, getAllChildren, getChildAtIndex, getChildCount, getChildren, getFirstChild, getLastChild, getTextContent, getTextContentWithConversion, hasChildren, onInsertAfter, onInsertAtIndex, onInsertBefore, onRemoveAllChildren, onRemoveChild, onRemoveChildAtIndex

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

forAllChildren, forAllChildren, forAllChildrenBreakable, forAllChildrenMapped, getChildCount, getChildren, hasChildren, hasNoChildren

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

forAllChildrenRecursive, forAllChildrenRecursive

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

findFirstChild, findFirstChildMapped, getChildAtIndex

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

isStandalone, setStandalone

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, containsAnyChild, detachFromParent, findParentElement, getAllChildren, getAllChildrenRecursive, getAllEventTargets, getAllEventTargets, getFirstChild, getLastChild, getNextSibling, getNodeValue, getParent, getParentElementWithName, getParentElementWithName, getPreviousSibling, 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

getTextContent, getTextContentTrimmed, getTextContentWithConversion

Field Details

DEFAULT_STANDALONE

public static final com.helger.commons.state.ETriState DEFAULT_STANDALONE

Constructor Details

MicroDocument

public MicroDocument()

MicroDocument

public MicroDocument(@Nullable
 IMicroDocumentType aDocType)

Method Details

getType

@Nonnull
public EMicroNodeType getType()

Specified by:

getType in interface IMicroNode

Returns:

The node type. Never null.

getNodeName

public String getNodeName()

Specified by:

getNodeName in interface IMicroNode

Returns:

Just an abstract name that depends on the implementing class. For IMicroElement nodes this is the same as the tag name.

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 AbstractMicroNodeWithChildren

Parameters:

aChildNode - The appended child node.

getStandalone

@Nonnull
public com.helger.commons.state.ETriState getStandalone()

Specified by:

getStandalone in interface IMicroDocument

Returns:

The standalone value. Never null.

setStandalone

public void setStandalone(@Nonnull
 com.helger.commons.state.ETriState eStandalone)

Description copied from interface: IMicroDocument

Change the standalone state of this document.

Specified by:

setStandalone in interface IMicroDocument

Parameters:

eStandalone - The new value. May not be null.

getDocType

@Nullable
public IMicroDocumentType getDocType()

Specified by:

getDocType in interface IMicroDocument

Returns:

May be null.

getDocumentElement

@Nullable
public IMicroElement getDocumentElement()

Specified by:

getDocumentElement in interface IMicroDocument

Returns:

May be null.

getClone

@Nonnull
public IMicroDocument getClone()

Description copied from interface: IMicroDocument

Specified by:

getClone in interface com.helger.commons.lang.ICloneable<IMicroNode>

Specified by:

getClone in interface IMicroDocument

Specified by:

getClone in interface IMicroNodeWithChildren

isEqualContent

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

Overrides:

isEqualContent in class AbstractMicroNodeWithChildren

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 AbstractMicroNodeWithChildren