com.phloc.commons.microdom

Interface IMicroDocument

All Superinterfaces:

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

All Known Implementing Classes:

MicroDocument

public interface IMicroDocument
extends IMicroNodeWithChildren

Represents a complete document.

Author:

Philip Helger

Method Summary

Methods

Modifier and Type	Method and Description
IMicroDocument	getClone()
IMicroDocumentType	getDocType()
IMicroElement	getDocumentElement()
boolean	isStandalone()
void	setStandalone(boolean bIsStandalone) Change the standalone state of this document.

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

getTextContent, getTextContentTrimmed, getTextContentWithConversion

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, getAllChildrenRecursive, getChildren, getFirstChild, getLastChild, getNextSibling, getNodeName, getNodeValue, getParent, getParentElementWithName, getParentElementWithName, getPreviousSibling, getType, hasChildren, 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.phloc.commons.parent.IHasChildrenSorted

getChildAtIndex

Methods inherited from interface com.phloc.commons.parent.IHasChildren

getChildCount

Method Detail

isStandalone

boolean isStandalone()

Returns:

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

setStandalone

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

Specified by:

getClone in interface IMicroNodeWithChildren

Returns:

A 100% deep-copy of the implementing class.