com.helger.commons.microdom

Class MicroDocument

java.lang.Object

com.helger.commons.microdom.AbstractMicroNode

com.helger.commons.microdom.AbstractMicroNodeWithChildren

com.helger.commons.microdom.MicroDocument

All Implemented Interfaces:

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

public final class MicroDocument
extends AbstractMicroNodeWithChildren
implements IMicroDocument

Default implementation of the IMicroDocument interface.

Author:

Philip Helger

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_STANDALONE By default a document is not standalone

Constructor Summary

Constructors

Constructor and Description
MicroDocument()
MicroDocument(IMicroDocumentType aDocType)

Method Summary

Modifier and Type	Method and Description
IMicroDocument	getClone()
IMicroDocumentType	getDocType()
IMicroElement	getDocumentElement()
String	getNodeName()
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.
boolean	isStandalone()
protected void	onAppendChild(AbstractMicroNode aChildNode) Callback that is invoked once a child is to be appended.
void	setStandalone(boolean bIsStandalone) Change the standalone state of this document.
String	toString()

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

getAllChildren, getAllChildrenRecursive, getChildAtIndex, getChildCount, getFirstChild, getLastChild, getTextContent, getTextContentWithConversion, hasChildren, onInsertAfter, onInsertAtIndex, onInsertBefore, onRemoveAllChildren, onRemoveChild, onRemoveChildAtIndex

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

appendCDATA, appendCDATA, appendCDATAWithConversion, appendChild, appendComment, appendComment, appendCommentWithConversion, appendContainer, appendElement, appendElement, appendEntityReference, appendIgnorableWhitespaceText, appendIgnorableWhitespaceText, appendProcessingInstruction, appendText, appendText, appendTextWithConversion, detachFromParent, getAllEventTargets, getAllEventTargets, getNextSibling, 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.helger.commons.microdom.IMicroNodeWithChildren

getTextContent, getTextContentTrimmed, getTextContentWithConversion

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

appendCDATA, appendCDATA, appendCDATA, appendCDATAWithConversion, appendChild, appendComment, appendComment, appendComment, appendCommentWithConversion, appendContainer, appendElement, appendElement, appendEntityReference, appendIgnorableWhitespaceText, appendIgnorableWhitespaceText, appendIgnorableWhitespaceText, appendProcessingInstruction, appendText, appendText, appendText, appendTextWithConversion, detachFromParent, getAllChildren, getAllChildrenRecursive, getAllEventTargets, getAllEventTargets, getFirstChild, getLastChild, getNextSibling, getNodeValue, getParent, getParentElementWithName, getParentElementWithName, getPreviousSibling, hasChildren, 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.commons.hierarchy.IHasChildrenSorted

getChildAtIndex

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

getChildCount, hasNoChildren

Field Detail

DEFAULT_STANDALONE

public static final boolean DEFAULT_STANDALONE

By default a document is not standalone

See Also:

Constant Field Values

Constructor Detail

MicroDocument

public MicroDocument()

MicroDocument

public MicroDocument(@Nullable
                     IMicroDocumentType aDocType)

Method Detail

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.

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.

isStandalone

public boolean isStandalone()

Specified by:

isStandalone in interface IMicroDocument

Returns:

true if the document is standalone, false if not. The default value is false.

setStandalone

public void setStandalone(boolean bIsStandalone)

Description copied from interface: IMicroDocument

Change the standalone state of this document.

Specified by:

setStandalone in interface IMicroDocument

Parameters:

bIsStandalone - The new value. true for standalone, false if not.

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

Specified by:

getClone in interface IMicroDocument

Specified by:

getClone in interface IMicroNodeWithChildren

Returns:

A 100% deep-copy of the implementing class.

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