Package com.helger.xml.microdom

Interface IMicroDocument

All Superinterfaces:

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

All Known Implementing Classes:

MicroDocument

public interface IMicroDocument
extends IMicroNodeWithChildren

Represents a complete document.

Author:

Philip Helger

Method Summary

Modifier and Type	Method	Description
IMicroDocument	getClone()
IMicroDocumentType	getDocType()
IMicroElement	getDocumentElement()
com.helger.commons.state.ETriState	getStandalone()
default boolean	isStandalone()
default void	setStandalone(boolean bIsStandalone)	Change the standalone state of this document.
void	setStandalone(com.helger.commons.state.ETriState eStandalone)	Change the standalone state of this document.

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

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

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

getTextContent, getTextContentTrimmed, getTextContentWithConversion

Method Details

getStandalone

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

Returns:

The standalone value. Never null.

Since:

9.3.5

isStandalone

default boolean isStandalone()

Returns:

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

setStandalone

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

Change the standalone state of this document.

Parameters:

eStandalone - The new value. May not be null.

Since:

9.3.5

setStandalone

default void setStandalone(boolean bIsStandalone)

Change the standalone state of this document.

Parameters:

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

getDocType

@Nullable
IMicroDocumentType getDocType()

Returns:

May be null.

getDocumentElement

@Nullable
IMicroElement getDocumentElement()

Returns:

May be null.

getClone

@Nonnull
IMicroDocument getClone()

Specified by:

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

Specified by:

getClone in interface IMicroNodeWithChildren