Document

java.lang.Object
- org.jdom2.Document

所有已实现的接口:

java.io.Serializable, java.lang.Cloneable, NamespaceAware, Parent
```
public class Document
extends java.lang.Object
implements Parent
```
An XML document. Methods allow access to the root element as well as the DocType and other document-level information.

作者:

Brett McLaughlin, Jason Hunter, Jools Enticknap, Bradley S. Huffman, Rolf Lear

另请参阅:

序列化表格

构造器概要

构造器
构造器和说明
`Document()` Creates a new empty document.
`Document(Element rootElement)` This will create a new `Document`, with the supplied `Element` as the root element, and no `DocType` declaration.
`Document(Element rootElement, DocType docType)` This will create a new `Document`, with the supplied `Element` as the root element and the supplied `DocType` declaration.
`Document(Element rootElement, DocType docType, java.lang.String baseURI)` This will create a new `Document`, with the supplied `Element` as the root element, the supplied `DocType` declaration, and the specified base URI.
`Document(java.util.List<? extends Content> content)` This will create a new `Document`, with the supplied list of content, and a `DocType` declaration only if the content contains a DocType instance.

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`Document`	`addContent(java.util.Collection<? extends Content> c)` Appends all children in the given collection to the end of the content list.
`Document`	`addContent(Content child)` Appends the child to the end of the content list.
`Document`	`addContent(int index, java.util.Collection<? extends Content> c)` Inserts the content in a collection into the content list at the given index.
`Document`	`addContent(int index, Content child)` Inserts the child into the content list at the given index.
`void`	`canContainContent(Content child, int index, boolean replace)` Test whether this Parent instance can contain the specified content at the specified position.
`Document`	`clone()` This will return a deep clone of this `Document`.
`java.util.List<Content>`	`cloneContent()` Returns a list containing detached clones of this parent's content list.
`Element`	`detachRootElement()` Detach the root `Element` from this document.
`boolean`	`equals(java.lang.Object ob)` This tests for equality of this `Document` to the supplied `Object`.
`java.lang.String`	`getBaseURI()` Returns the URI from which this document was loaded, or null if this is not known.
`java.util.List<Content>`	`getContent()` This will return all content for the `Document`.
`<F extends Content> java.util.List<F>`	`getContent(Filter<F> filter)` Return a filtered view of this `Document`'s content.
`Content`	`getContent(int index)` Returns the child at the given index.
`int`	`getContentSize()` Returns the number of children in this parent's content list.
`IteratorIterable<Content>`	`getDescendants()` Returns an iterator that walks over all descendants in document order.
`<F extends Content> IteratorIterable<F>`	`getDescendants(Filter<F> filter)` Returns an iterator that walks over all descendants in document order applying the Filter to return only elements that match the filter rule.
`DocType`	`getDocType()` This will return the `DocType` declaration for this `Document`, or `null` if none exists.
`Document`	`getDocument()` Always returns this Document Instance
`java.util.List<Namespace>`	`getNamespacesInherited()` Obtain a list of all namespaces that are in scope for this content, but were not introduced by this content.
`java.util.List<Namespace>`	`getNamespacesInScope()` Get the Namespaces that are in-scope on this Document.
`java.util.List<Namespace>`	`getNamespacesIntroduced()` Obtain a list of all namespaces that are introduced to the XML tree by this node.
`Parent`	`getParent()` Always returns null, Document cannot have a parent.
`java.lang.Object`	`getProperty(java.lang.String id)` Returns the object associated with this document under the given "id" string, or null if there is no binding or if the binding explicitly stored a null value.
`Element`	`getRootElement()` This will return the root `Element` for this `Document`
`int`	`hashCode()` This returns the hash code for this `Document`.
`boolean`	`hasRootElement()` This will return `true` if this document has a root element, `false` otherwise.
`int`	`indexOf(Content child)` Returns the index of the supplied child in the content list, or -1 if not a child of this parent.
`java.util.List<Content>`	`removeContent()` Removes all child content from this parent.
`boolean`	`removeContent(Content child)` Removes a single child node from the content list.
`<F extends Content> java.util.List<F>`	`removeContent(Filter<F> filter)` Remove all child content from this parent matching the supplied filter.
`Content`	`removeContent(int index)` Removes and returns the child at the given index, or returns null if there's no such child.
`void`	`setBaseURI(java.lang.String uri)` Sets the effective URI from which this document was loaded, and against which relative URLs in this document will be resolved.
`Document`	`setContent(java.util.Collection<? extends Content> newContent)` This sets the content of the `Document`.
`Document`	`setContent(Content child)` Set this document's content to be the supplied child.
`Document`	`setContent(int index, java.util.Collection<? extends Content> collection)` Replace the child at the given index whith the supplied collection.
`Document`	`setContent(int index, Content child)` Replace the current child the given index with the supplied child.
`Document`	`setDocType(DocType docType)` This will set the `DocType` declaration for this `Document`.
`void`	`setProperty(java.lang.String id, java.lang.Object value)` Assigns an arbitrary object to be associated with this document under the given "id" string.
`Document`	`setRootElement(Element rootElement)` This sets the root `Element` for the `Document`.
`java.lang.String`	`toString()` This returns a `String` representation of the `Document`, suitable for debugging.

从类继承的方法 java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- 构造器详细资料
  - Document
```
public Document()
```
    Creates a new empty document. A document must have a root element, so this document will not be well-formed and accessor methods will throw an IllegalStateException if this document is accessed before a root element is added. This method is most useful for build tools.
  - Document
```
public Document(Element rootElement,
                DocType docType,
                java.lang.String baseURI)
```
    This will create a new Document, with the supplied Element as the root element, the supplied DocType declaration, and the specified base URI.
    
    参数:
    
    rootElement - Element for document root.
    
    docType - DocType declaration.
    
    baseURI - the URI from which this doucment was loaded.
    
    抛出:
    
    IllegalAddException - if the given docType object is already attached to a document or the given rootElement already has a parent
  - Document
```
public Document(Element rootElement,
                DocType docType)
```
    This will create a new Document, with the supplied Element as the root element and the supplied DocType declaration.
    
    参数:
    
    rootElement - Element for document root.
    
    docType - DocType declaration.
    
    抛出:
    
    IllegalAddException - if the given DocType object is already attached to a document or the given rootElement already has a parent
  - Document
```
public Document(Element rootElement)
```
    This will create a new Document, with the supplied Element as the root element, and no DocType declaration.
    
    参数:
    
    rootElement - Element for document root
    
    抛出:
    
    IllegalAddException - if the given rootElement already has a parent.
  - Document
```
public Document(java.util.List<? extends Content> content)
```
    This will create a new Document, with the supplied list of content, and a DocType declaration only if the content contains a DocType instance. A null list is treated the same as the no-arg constructor.
    
    参数:
    
    content - List of starter content
    
    抛出:
    
    IllegalAddException - if the List contains more than one Element or objects of illegal types.
- 方法详细资料
  - getContentSize
```
public int getContentSize()
```
    从接口复制的说明: Parent
    
    Returns the number of children in this parent's content list. Children may be any Content type.
    
    指定者:
    
    getContentSize 在接口中 Parent
    
    返回:
    
    number of children
  - indexOf
```
public int indexOf(Content child)
```
    从接口复制的说明: Parent
    
    Returns the index of the supplied child in the content list, or -1 if not a child of this parent.
    
    指定者:
    
    indexOf 在接口中 Parent
    
    参数:
    
    child - child to search for
    
    返回:
    
    index of child, or -1 if not found
  - hasRootElement
```
public boolean hasRootElement()
```
    This will return true if this document has a root element, false otherwise.
    
    返回:
    
    true if this document has a root element, false otherwise.
  - getRootElement
```
public Element getRootElement()
```
    This will return the root Element for this Document
    
    返回:
    
    Element - the document's root element
    
    抛出:
    
    java.lang.IllegalStateException - if the root element hasn't been set
  - setRootElement
```
public Document setRootElement(Element rootElement)
```
    This sets the root Element for the Document. If the document already has a root element, it is replaced.
    
    参数:
    
    rootElement - Element to be new root.
    
    返回:
    
    Document - modified Document.
    
    抛出:
    
    IllegalAddException - if the given rootElement already has a parent.
  - detachRootElement
```
public Element detachRootElement()
```
    Detach the root Element from this document.
    
    返回:
    
    removed root Element
  - getDocType
```
public DocType getDocType()
```
    This will return the DocType declaration for this Document, or null if none exists.
    
    返回:
    
    DocType - the DOCTYPE declaration.
  - setDocType
```
public Document setDocType(DocType docType)
```
    This will set the DocType declaration for this Document. Note that a DocType can only be attached to one Document. Attempting to set the DocType to a DocType object that already belongs to a Document will result in an IllegalAddException being thrown.
    
    参数:
    
    docType - DocType declaration.
    
    返回:
    
    object on which the method was invoked
    
    抛出:
    
    IllegalAddException - if the given docType is already attached to a Document.
  - addContent
```
public Document addContent(Content child)
```
    Appends the child to the end of the content list.
    
    指定者:
    
    addContent 在接口中 Parent
    
    参数:
    
    child - child to append to end of content list
    
    返回:
    
    the document on which the method was called
    
    抛出:
    
    IllegalAddException - if the given child already has a parent.
  - addContent
```
public Document addContent(java.util.Collection<? extends Content> c)
```
    Appends all children in the given collection to the end of the content list. In event of an exception during add the original content will be unchanged and the objects in the supplied collection will be unaltered.
    
    指定者:
    
    addContent 在接口中 Parent
    
    参数:
    
    c - collection to append
    
    返回:
    
    the document on which the method was called
    
    抛出:
    
    IllegalAddException - if any item in the collection already has a parent or is of an illegal type.
  - addContent
```
public Document addContent(int index,
                           Content child)
```
    Inserts the child into the content list at the given index.
    
    指定者:
    
    addContent 在接口中 Parent
    
    参数:
    
    index - location for adding the collection
    
    child - child to insert
    
    返回:
    
    the parent on which the method was called
    
    抛出:
    
    java.lang.IndexOutOfBoundsException - if index is negative or beyond the current number of children
    
    IllegalAddException - if the given child already has a parent.
  - addContent
```
public Document addContent(int index,
                           java.util.Collection<? extends Content> c)
```
    Inserts the content in a collection into the content list at the given index. In event of an exception the original content will be unchanged and the objects in the supplied collection will be unaltered.
    
    指定者:
    
    addContent 在接口中 Parent
    
    参数:
    
    index - location for adding the collection
    
    c - collection to insert
    
    返回:
    
    the parent on which the method was called
    
    抛出:
    
    java.lang.IndexOutOfBoundsException - if index is negative or beyond the current number of children
    
    IllegalAddException - if any item in the collection already has a parent or is of an illegal type.
  - cloneContent
```
public java.util.List<Content> cloneContent()
```
    从接口复制的说明: Parent
    
    Returns a list containing detached clones of this parent's content list.
    
    指定者:
    
    cloneContent 在接口中 Parent
    
    返回:
    
    list of cloned child content
  - getContent
```
public Content getContent(int index)
```
    从接口复制的说明: Parent
    
    Returns the child at the given index.
    
    指定者:
    
    getContent 在接口中 Parent
    
    参数:
    
    index - location of desired child
    
    返回:
    
    child at the given index
  - getContent
```
public java.util.List<Content> getContent()
```
    This will return all content for the Document. The returned list is "live" in document order and changes to it affect the document's actual content.
    Sequential traversal through the List is best done with a Iterator since the underlying implement of List.size() may require walking the entire list.
    
    指定者:
    
    getContent 在接口中 Parent
    
    返回:
    
    List - all Document content
    
    抛出:
    
    java.lang.IllegalStateException - if the root element hasn't been set
  - getContent
```
public <F extends Content> java.util.List<F> getContent(Filter<F> filter)
```
    Return a filtered view of this Document's content.
    Sequential traversal through the List is best done with a Iterator since the underlying implement of List.size() may require walking the entire list.
    
    指定者:
    
    getContent 在接口中 Parent
    
    类型参数:
    
    F - The Generic type of the returned content (the Filter's type)
    
    参数:
    
    filter - Filter to apply
    
    返回:
    
    List - filtered Document content
    
    抛出:
    
    java.lang.IllegalStateException - if the root element hasn't been set
  - removeContent
```
public java.util.List<Content> removeContent()
```
    Removes all child content from this parent.
    
    指定者:
    
    removeContent 在接口中 Parent
    
    返回:
    
    list of the old children detached from this parent
  - removeContent
```
public <F extends Content> java.util.List<F> removeContent(Filter<F> filter)
```
    Remove all child content from this parent matching the supplied filter.
    
    指定者:
    
    removeContent 在接口中 Parent
    
    类型参数:
    
    F - The Generic type of the content to remove.
    
    参数:
    
    filter - filter to select which content to remove
    
    返回:
    
    list of the old children detached from this parent
  - setContent
```
public Document setContent(java.util.Collection<? extends Content> newContent)
```
    This sets the content of the Document. The supplied List should contain only objects of type Element, Comment, and ProcessingInstruction.
    When all objects in the supplied List are legal and before the new content is added, all objects in the old content will have their parentage set to null (no parent) and the old content list will be cleared. This has the effect that any active list (previously obtained with a call to getContent(int)) will also change to reflect the new content. In addition, all objects in the supplied List will have their parentage set to this document, but the List itself will not be "live" and further removals and additions will have no effect on this document content. If the user wants to continue working with a "live" list, then a call to setContent should be followed by a call to getContent(int) to obtain a "live" version of the content.
    
    Passing a null or empty List clears the existing content.
    
    In event of an exception the original content will be unchanged and the objects in the supplied content will be unaltered.
    
    参数:
    
    newContent - List of content to set
    
    返回:
    
    this document modified
    
    抛出:
    
    IllegalAddException - if the List contains objects of illegal types or with existing parentage.
  - setBaseURI
```
public final void setBaseURI(java.lang.String uri)
```
    Sets the effective URI from which this document was loaded, and against which relative URLs in this document will be resolved.
    
    参数:
    
    uri - the base URI of this document
  - getBaseURI
```
public final java.lang.String getBaseURI()
```
    Returns the URI from which this document was loaded, or null if this is not known.
    
    返回:
    
    the base URI of this document
  - setContent
```
public Document setContent(int index,
                           Content child)
```
    Replace the current child the given index with the supplied child.
    In event of an exception the original content will be unchanged and the supplied child will be unaltered.
    
    参数:
    
    index - - index of child to replace.
    
    child - - child to add.
    
    返回:
    
    this document instance
    
    抛出:
    
    IllegalAddException - if the supplied child is already attached or not legal content for this parent.
    
    java.lang.IndexOutOfBoundsException - if index is negative or greater than the current number of children.
  - setContent
```
public Document setContent(int index,
                           java.util.Collection<? extends Content> collection)
```
    Replace the child at the given index whith the supplied collection.
    In event of an exception the original content will be unchanged and the content in the supplied collection will be unaltered.
    
    参数:
    
    index - - index of child to replace.
    
    collection - - collection of content to add.
    
    返回:
    
    object on which the method was invoked
    
    抛出:
    
    IllegalAddException - if the collection contains objects of illegal types.
    
    java.lang.IndexOutOfBoundsException - if index is negative or greater than the current number of children.
  - removeContent
```
public boolean removeContent(Content child)
```
    从接口复制的说明: Parent
    
    Removes a single child node from the content list.
    
    指定者:
    
    removeContent 在接口中 Parent
    
    参数:
    
    child - child to remove
    
    返回:
    
    whether the removal occurred
  - removeContent
```
public Content removeContent(int index)
```
    从接口复制的说明: Parent
    
    Removes and returns the child at the given index, or returns null if there's no such child.
    
    指定者:
    
    removeContent 在接口中 Parent
    
    参数:
    
    index - index of child to remove
    
    返回:
    
    detached child at given index or null if no
  - setContent
```
public Document setContent(Content child)
```
    Set this document's content to be the supplied child.
    If the supplied child is legal content for a Document and before it is added, all content in the current content list will be cleared and all current children will have their parentage set to null.
    This has the effect that any active list (previously obtained with a call to one of the getContent(int) methods will also change to reflect the new content. In addition, all content in the supplied collection will have their parentage set to this Document. If the user wants to continue working with a "live" list of this Document's child, then a call to setContent should be followed by a call to one of the getContent(int) methods to obtain a "live" version of the children.
    Passing a null child clears the existing content.
    In event of an exception the original content will be unchanged and the supplied child will be unaltered.
    
    参数:
    
    child - new content to replace existing content
    
    返回:
    
    the parent on which the method was called
    
    抛出:
    
    IllegalAddException - if the supplied child is already attached or not legal content for this parent
  - toString
```
public java.lang.String toString()
```
    This returns a String representation of the Document, suitable for debugging. If the XML representation of the Document is desired, XMLOutputter.outputString(Document) should be used.
    
    覆盖:
    
    toString 在类中 java.lang.Object
    
    返回:
    
    String - information about the Document
  - equals
```
public final boolean equals(java.lang.Object ob)
```
    This tests for equality of this Document to the supplied Object.
    
    覆盖:
    
    equals 在类中 java.lang.Object
    
    参数:
    
    ob - Object to compare to
    
    返回:
    
    boolean whether the Document is equal to the supplied Object
  - hashCode
```
public final int hashCode()
```
    This returns the hash code for this Document.
    
    覆盖:
    
    hashCode 在类中 java.lang.Object
    
    返回:
    
    int hash code
  - clone
```
public Document clone()
```
    This will return a deep clone of this Document.
    
    指定者:
    
    clone 在接口中 Parent
    
    返回:
    
    Object clone of this Document
  - getDescendants
```
public IteratorIterable<Content> getDescendants()
```
    Returns an iterator that walks over all descendants in document order.
    
    指定者:
    
    getDescendants 在接口中 Parent
    
    返回:
    
    an iterator to walk descendants
  - getDescendants
```
public <F extends Content> IteratorIterable<F> getDescendants(Filter<F> filter)
```
    Returns an iterator that walks over all descendants in document order applying the Filter to return only elements that match the filter rule. With filters you can match only Elements, only Comments, Elements or Comments, only Elements with a given name and/or prefix, and so on.
    
    指定者:
    
    getDescendants 在接口中 Parent
    
    类型参数:
    
    F - E
    
    参数:
    
    filter - filter to select which descendants to see
    
    返回:
    
    an iterator to walk descendants within a filter
  - getParent
```
public Parent getParent()
```
    Always returns null, Document cannot have a parent.
    
    指定者:
    
    getParent 在接口中 Parent
    
    返回:
    
    null
  - getDocument
```
public Document getDocument()
```
    Always returns this Document Instance
    
    指定者:
    
    getDocument 在接口中 Parent
    
    返回:
    
    'this' because this Document is it's own Document
  - setProperty
```
public void setProperty(java.lang.String id,
                        java.lang.Object value)
```
    Assigns an arbitrary object to be associated with this document under the given "id" string. Null values are permitted. 'id' Strings beginning with "http://www.jdom.org/ are reserved for JDOM use. Properties set with this method will not be serialized with the rest of this Document, should serialization need to be done.
    
    参数:
    
    id - the id of the stored Object
    
    value - the Object to store
  - getProperty
```
public java.lang.Object getProperty(java.lang.String id)
```
    Returns the object associated with this document under the given "id" string, or null if there is no binding or if the binding explicitly stored a null value.
    
    参数:
    
    id - the id of the stored Object to return
    
    返回:
    
    the Object associated with the given id
  - canContainContent
```
public void canContainContent(Content child,
                              int index,
                              boolean replace)
```
    从接口复制的说明: Parent
    
    Test whether this Parent instance can contain the specified content at the specified position.
    
    指定者:
    
    canContainContent 在接口中 Parent
    
    参数:
    
    child - The content to be checked
    
    index - The location where the content would be put.
    
    replace - true if the intention is to replace the content already at the index.
  - getNamespacesInScope
```
public java.util.List<Namespace> getNamespacesInScope()
```
    Get the Namespaces that are in-scope on this Document.
    Document always has exactly two Namespaces in-scope: Namespace.NO_NAMESPACE and Namespace.XML_NAMESPACE.
    These namespaces are always introduced by the Document, and thus they are both returned by getNamespacesIntroduced(), and additionally getNamespacesInherited() will always be empty.
    Description copied from NamespaceAware.getNamespacesInScope():
    Obtain a list of all namespaces that are in scope for the current content.
    The contents of this list will always be the combination of getNamespacesIntroduced() and getNamespacesInherited().
    See NamespaceAware documentation for details on what the order of the Namespaces will be in the returned list.
    
    指定者:
    
    getNamespacesInScope 在接口中 NamespaceAware
    
    返回:
    
    a read-only list of Namespaces.
  - getNamespacesIntroduced
```
public java.util.List<Namespace> getNamespacesIntroduced()
```
    从接口复制的说明: NamespaceAware
    
    Obtain a list of all namespaces that are introduced to the XML tree by this node. Only Elements and Attributes can introduce namespaces, so all other Content types will return an empty list.
    The contents of this list will always be a subset (but in the same order) of getNamespacesInScope(), and will never intersect getNamspacesInherited()
    
    指定者:
    
    getNamespacesIntroduced 在接口中 NamespaceAware
    
    返回:
    
    a read-only list of Namespaces.
  - getNamespacesInherited
```
public java.util.List<Namespace> getNamespacesInherited()
```
    从接口复制的说明: NamespaceAware
    
    Obtain a list of all namespaces that are in scope for this content, but were not introduced by this content.
    The contents of this list will always be a subset (but in the same order) of getNamespacesInScope(), and will never intersect getNamspacesIntroduced()
    
    指定者:
    
    getNamespacesInherited 在接口中 NamespaceAware
    
    返回:
    
    a read-only list of Namespaces.

类 Document

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

Document

Document

Document

Document

Document

方法详细资料

getContentSize

indexOf

hasRootElement

getRootElement

setRootElement

detachRootElement

getDocType

setDocType

addContent

addContent

addContent

addContent

cloneContent

getContent

getContent

getContent

removeContent

removeContent

setContent

setBaseURI

getBaseURI

setContent

setContent

removeContent

removeContent

setContent

toString

equals

hashCode

clone

getDescendants

getDescendants

getParent

getDocument

setProperty

getProperty

canContainContent

getNamespacesInScope

getNamespacesIntroduced

getNamespacesInherited