Uses of Class org.jdom.Document (JDOM v1.1.1)
Date: 2018-05-07

## Uses of Class
org.jdom.Document

- Packages that use Document
  Package | Description
  --- | ---
  org.jdom | Classes to represent the components of an XML document.
  org.jdom.input | Classes to build JDOM documents from various sources.
  org.jdom.output | Classes to output JDOM documents to various destinations.
  org.jdom.transform | Classes to help with transformations, based on the JAXP TrAX classes.

- - ### Uses of Document in org.jdom

    Methods in org.jdom that return Document
    Modifier and Type | Method and Description
    --- | ---
    `Document` | Document.`addContent(java.util.Collection c)` Appends all children in the given collection to the end of the content list.
    `Document` | Document.`addContent(Content child)` Appends the child to the end of the content list.
    `Document` | Document.`addContent(int index, java.util.Collection c)` Inserts the content in a collection into the content list at the given index.
    `Document` | Document.`addContent(int index, Content child)` Inserts the child into the content list at the given index.
    `Document` | UncheckedJDOMFactory.`document(Element rootElement)`
    `Document` | JDOMFactory.`document(Element rootElement)` This will create a new `Document`, with the supplied ``Element`` as the root element, and no ``DocType`` declaration.
    `Document` | DefaultJDOMFactory.`document(Element rootElement)`
    `Document` | UncheckedJDOMFactory.`document(Element rootElement, DocType docType)`
    `Document` | JDOMFactory.`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` | DefaultJDOMFactory.`document(Element rootElement, DocType docType)`
    `Document` | UncheckedJDOMFactory.`document(Element rootElement, DocType docType, java.lang.String baseURI)`
    `Document` | JDOMFactory.`document(Element rootElement, DocType docType, java.lang.String baseURI)` This will create a new `Document`, with the supplied ``Element`` as the root element and the supplied ``DocType`` declaration.
    `Document` | DefaultJDOMFactory.`document(Element rootElement, DocType docType, java.lang.String baseURI)`
    `Document` | Document.`getDocument()`
    `Document` | Parent.`getDocument()` Return this parent's owning document or null if the branch containing this parent is currently not attached to a document.
    `Document` | Content.`getDocument()` Return this child's owning document or null if the branch containing this child is currently not attached to a document.
    `Document` | Attribute.`getDocument()` This retrieves the owning ``Document`` for this Attribute, or null if not a currently a member of a ``Document``.
    `Document` | Document.`setContent(java.util.Collection newContent)` This sets the content of the `Document`.
    `Document` | Document.`setContent(Content child)` Set this document's content to be the supplied child.
    `Document` | Document.`setContent(int index, java.util.Collection collection)` Replace the child at the given index whith the supplied collection.
    `Document` | Document.`setContent(int index, Content child)`
    `Document` | Document.`setDocType(DocType docType)` This will set the ``DocType`` declaration for this `Document`.
    `Document` | Document.`setRootElement(Element rootElement)` This sets the root ``Element`` for the `Document`.

  - ### Uses of Document in org.jdom.input

    Methods in org.jdom.input that return Document
    Modifier and Type | Method and Description
    --- | ---
    `Document` | DOMBuilder.`build(org.w3c.dom.Document domDocument)` This will build a JDOM tree from an existing DOM tree.
    `Document` | SAXBuilder.`build(java.io.File file)` This builds a document from the supplied filename.
    `Document` | SAXBuilder.`build(org.xml.sax.InputSource in)` This builds a document from the supplied input source.
    `Document` | SAXBuilder.`build(java.io.InputStream in)` This builds a document from the supplied input stream.
    `Document` | SAXBuilder.`build(java.io.InputStream in, java.lang.String systemId)` This builds a document from the supplied input stream.
    `Document` | SAXBuilder.`build(java.io.Reader characterStream)` This builds a document from the supplied Reader.
    `Document` | SAXBuilder.`build(java.io.Reader characterStream, java.lang.String systemId)` This builds a document from the supplied Reader.
    `Document` | SAXBuilder.`build(java.lang.String systemId)` This builds a document from the supplied URI.
    `Document` | SAXBuilder.`build(java.net.URL url)` This builds a document from the supplied URL.
    `Document` | SAXHandler.`getDocument()` Returns the document.
    `Document` | JDOMParseException.`getPartialDocument()` Returns the partial document that was successfully built before the error occurred.

    Constructors in org.jdom.input with parameters of type Document
    Constructor and Description
    `JDOMParseException(java.lang.String message, java.lang.Throwable cause, Document partialDocument)` This will create a parse `Exception` with the given message and the partial document and wrap the `Exception` that cause a document parse to fail.

  - ### Uses of Document in org.jdom.output

    Methods in org.jdom.output with parameters of type Document
    Modifier and Type | Method and Description
    --- | ---
    `void` | SAXOutputter.`output(Document document)` This will output the `JDOM Document`, firing off the SAX events that have been registered.
    `org.w3c.dom.Document` | DOMOutputter.`output(Document document)` This converts the JDOM `Document` parameter to a DOM Document, returning the DOM version.
    `void` | XMLOutputter.`output(Document doc, java.io.OutputStream out)` This will print the `Document` to the given output stream.
    `void` | XMLOutputter.`output(Document doc, java.io.Writer out)` This will print the `Document` to the given Writer.
    `java.lang.String` | XMLOutputter.`outputString(Document doc)` Return a string representing a document.
    `protected void` | XMLOutputter.`printDeclaration(java.io.Writer out, Document doc, java.lang.String encoding)` This will handle printing of the declaration.

  - ### Uses of Document in org.jdom.transform

    Methods in org.jdom.transform that return Document
    Modifier and Type | Method and Description
    --- | ---
    `Document` | JDOMSource.`getDocument()` Returns the source document used by this TrAX source.
    `Document` | JDOMResult.`getDocument()` Returns the result of an XSL Transformation as a JDOM document.
    `Document` | XSLTransformer.`transform(Document inputDoc)` Transforms the given document to an output document.
    `Document` | XSLTransformer.`transform(Document inputDoc, org.xml.sax.EntityResolver resolver)` Transforms the given document to an output document.

    Methods in org.jdom.transform with parameters of type Document
    Modifier and Type | Method and Description
    --- | ---
    `void` | JDOMSource.`setDocument(Document source)` Sets the source document used by this TrAX source.
    `void` | JDOMResult.`setDocument(Document document)` Sets the document produced as result of an XSL Transformation.
    `Document` | XSLTransformer.`transform(Document inputDoc)` Transforms the given document to an output document.
    `Document` | XSLTransformer.`transform(Document inputDoc, org.xml.sax.EntityResolver resolver)` Transforms the given document to an output document.

    Constructors in org.jdom.transform with parameters of type Document
    Constructor and Description
    `JDOMSource(Document source)` Creates a JDOM TrAX source wrapping a JDOM document.
    `JDOMSource(Document source, org.xml.sax.EntityResolver resolver)` Creates a JDOM TrAX source wrapping a JDOM element with an associated EntityResolver to resolve external entities.
    `XSLTransformer(Document stylesheet)` This will create a new `XSLTransformer` by reading the stylesheet from the specified `Document`.

Copyright ? 2007 Jason Hunter, Brett McLaughlin. All Rights Reserved.