Class DefaultDocument
java.lang.Object
org.dom4j.tree.AbstractNode
org.dom4j.tree.AbstractBranch
org.dom4j.tree.AbstractDocument
org.dom4j.tree.DefaultDocument
- All Implemented Interfaces:
Serializable, Cloneable, Branch, Document, Node
- Direct Known Subclasses:
DOMDocument
DefaultDocument
is the default DOM4J default implementation of
an XML document.
- Version:
- $Revision: 1.34 $
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionStore the contents of the document as a lazily createdList
private DocumentType
The document type for this documentprivate DocumentFactory
The document factory used by defaultprivate EntityResolver
The resolver of URIsprivate String
The name of the documentprivate Element
The root element of this documentFields inherited from class AbstractDocument
encoding
Fields inherited from class AbstractBranch
DEFAULT_CONTENT_LIST_SIZE
Fields inherited from class AbstractNode
NODE_TYPE_NAMES
Fields inherited from interface Node
ANY_NODE, ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_NODE, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_REFERENCE_NODE, MAX_NODE_TYPE, NAMESPACE_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE, UNKNOWN_NODE
-
Constructor Summary
ConstructorsConstructorDescriptionDefaultDocument
(String name) DefaultDocument
(String name, Element rootElement, DocumentType docType) DefaultDocument
(DocumentType docType) DefaultDocument
(Element rootElement) DefaultDocument
(Element rootElement, DocumentType docType) -
Method Summary
Modifier and TypeMethodDescriptionaddDocType
(String docTypeName, String publicId, String systemId) Adds a DOCTYPE declaration to this documentprotected void
protected void
void
Clears the content for this branch, removing anyNode
instances this branch may contain.clone()
clone
will return a deep clone or if this node is read-only then clone will return the same instance.DOCUMENT ME!DOCUMENT ME!protected DocumentFactory
DOCUMENT ME!getName()
getName
returns the name of this node.Returns the rootElement
for this document.Return the encoding of this document, as part of the XML declaration This isnull
when unspecified or when it is not known (such as when the Document was created in memory) or when the implementation does not support this operation.processingInstruction
(String target) DOCUMENT ME!Returns a list of all the processing instructions in this branch.processingInstructions
(String target) Returns a list of the processing instructions for the given target.protected boolean
removeNode
(Node node) boolean
removeProcessingInstruction
(String target) Removes the processing instruction for the given target if it existsprotected void
rootElementAdded
(Element element) Called to set the root element variablevoid
setContent
(List<Node> content) Sets the contents of this branch as aList
ofNode
instances.void
setDocType
(DocumentType docType) Sets the DocumentType propertyvoid
setDocumentFactory
(DocumentFactory documentFactory) void
setEntityResolver
(EntityResolver entityResolver) Sets the EntityResolver used to find resolve URIs such as for DTDs, or XML Schema documentsvoid
Sets the text data of this node or this method will throw anUnsupportedOperationException
if it is read-only.Methods inherited from class AbstractDocument
accept, add, addComment, addElement, addElement, addElement, addProcessingInstruction, addProcessingInstruction, asXML, asXPathResult, checkAddElementAllowed, childAdded, childRemoved, getDocument, getNodeType, getPath, getStringValue, getUniquePath, normalize, remove, setRootElement, setXMLEncoding, toString, write
Methods inherited from class AbstractBranch
add, add, add, addElement, appendContent, content, contentRemoved, createContentList, createContentList, createEmptyList, createResultList, createSingleResultList, elementByID, elementID, getContentAsStringValue, getContentAsText, getText, getTextTrim, hasContent, indexOf, invalidNodeTypeAddException, isReadOnly, node, nodeCount, nodeIterator, remove, remove, remove, setProcessingInstructions
Methods inherited from class AbstractNode
createPattern, createXPath, createXPathFilter, createXPathResult, detach, getNodeTypeName, getParent, getPath, getUniquePath, matches, numberValueOf, selectNodes, selectNodes, selectNodes, selectObject, selectSingleNode, setDocument, setParent, setText, supportsParent, valueOf
Methods inherited from class Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface Branch
add, add, add, appendContent, content, elementByID, indexOf, node, nodeCount, nodeIterator, remove, remove, remove, setProcessingInstructions
Methods inherited from interface Node
createXPath, detach, getNodeTypeName, getParent, getPath, getText, getUniquePath, hasContent, isReadOnly, matches, numberValueOf, selectNodes, selectNodes, selectNodes, selectObject, selectSingleNode, setDocument, setParent, setText, supportsParent, valueOf
-
Field Details
-
name
The name of the document -
rootElement
The root element of this document -
-
docType
The document type for this document -
documentFactory
The document factory used by default -
entityResolver
The resolver of URIs
-
-
Constructor Details
-
DefaultDocument
public DefaultDocument() -
DefaultDocument
-
DefaultDocument
-
DefaultDocument
-
DefaultDocument
-
DefaultDocument
-
-
Method Details
-
getName
Description copied from interface:Node
getName
returns the name of this node. This is the XML local name of the element, attribute, entity or processing instruction. For CDATA and Text nodes this method will return null.- Specified by:
getName
in interfaceNode
- Overrides:
getName
in classAbstractNode
- Returns:
- the XML name of this node
-
setName
Description copied from interface:Node
Sets the text data of this node or this method will throw an
UnsupportedOperationException
if it is read-only.- Specified by:
setName
in interfaceNode
- Overrides:
setName
in classAbstractNode
- Parameters:
name
- is the new name of this node
-
getRootElement
-
getDocType
-
setDocType
Description copied from interface:Document
Sets the DocumentType property- Parameters:
docType
- DOCUMENT ME!
-
addDocType
Description copied from interface:Document
Adds a DOCTYPE declaration to this document- Parameters:
docTypeName
- is the name of the root elementpublicId
- is the PUBLIC URIsystemId
- is the SYSTEM URI- Returns:
- this
Document
instance.
-
getXMLEncoding
Description copied from interface:Document
Return the encoding of this document, as part of the XML declaration This isnull
when unspecified or when it is not known (such as when the Document was created in memory) or when the implementation does not support this operation. The way this encoding is retrieved also depends on the way the XML source is parsed. For instance, if the SAXReader is used and if the underlying XMLReader implementation support theorg.xml.sax.ext.Locator2
interface, the result returned by this method is specified by thegetEncoding()
method of that interface.- Specified by:
getXMLEncoding
in interfaceDocument
- Overrides:
getXMLEncoding
in classAbstractDocument
- Returns:
- The encoding of this document, as stated in the XML declaration,
or
null
if unknown.
-
getEntityResolver
Description copied from interface:Document
DOCUMENT ME!- Returns:
- the EntityResolver used to find resolve URIs such as for DTDs, or XML Schema documents
-
setEntityResolver
Description copied from interface:Document
Sets the EntityResolver used to find resolve URIs such as for DTDs, or XML Schema documents- Parameters:
entityResolver
- DOCUMENT ME!
-
clone
Description copied from interface:Node
clone
will return a deep clone or if this node is read-only then clone will return the same instance.- Specified by:
clone
in interfaceNode
- Overrides:
clone
in classAbstractNode
- Returns:
- a deep clone of myself or myself if I am read only.
-
processingInstructions
Description copied from interface:Branch
Returns a list of all the processing instructions in this branch. The list is backed by this branch so that changes to the list will be reflected in the branch but the reverse is not the case.- Returns:
- a backed list of the processing instructions
-
processingInstructions
Description copied from interface:Branch
Returns a list of the processing instructions for the given target. The list is backed by this branch so that changes to the list will be reflected in the branch but the reverse is not the case.- Parameters:
target
- DOCUMENT ME!- Returns:
- a backed list of the processing instructions
-
processingInstruction
Description copied from interface:Branch
DOCUMENT ME!- Parameters:
target
- DOCUMENT ME!- Returns:
- the processing instruction for the given target
-
removeProcessingInstruction
-
setContent
-
clearContent
public void clearContent()Description copied from interface:Branch
Clears the content for this branch, removing anyNode
instances this branch may contain. -
setDocumentFactory
-
contentList
Description copied from class:AbstractBranch
DOCUMENT ME!- Specified by:
contentList
in classAbstractBranch
- Returns:
- the internal List used to manage the content
-
addNode
- Specified by:
addNode
in classAbstractBranch
-
addNode
- Specified by:
addNode
in classAbstractBranch
-
removeNode
- Specified by:
removeNode
in classAbstractBranch
-
rootElementAdded
Description copied from class:AbstractDocument
Called to set the root element variable- Specified by:
rootElementAdded
in classAbstractDocument
- Parameters:
element
- DOCUMENT ME!
-
getDocumentFactory
- Overrides:
getDocumentFactory
in classAbstractNode
-