All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class org.jdom.Document

java.lang.Object
   |
   +----org.jdom.Document

public class Document
extends Object
implements Serializable, Cloneable

Document defines behavior for an XML Document, modeled in Java. Methods allow the user to the root element as well as processing instructions and other document-level information.

Version:
1.0
Author:
Brett McLaughlin, Jason Hunter

Variable Index

 o content
This Document's {
 o docType
The {

Constructor Index

 o Document()

Default, no-args constructor for implementations to use if needed.

 o Document(Element)

This will create a new Document, with the supplied {

 o Document(Element, DocType)

This will create a new Document, with the supplied {

 o Document(List)

This will create a new Document, with the supplied list of content, and no {

 o Document(List, DocType)

This will create a new Document, with the supplied list of content, and the supplied {

Method Index

 o addContent(Comment)

This will add a comment to the Document.

 o addContent(ProcessingInstruction)

Adds the specified PI to the document.

 o clone()

This will return a deep clone of this Document.

 o equals(Object)

This tests for equality of this Document to the supplied Object.

 o getContent()

This will return all content for the Document.

 o getDocType()

This will return the {

 o getMixedContent()

This will return all content for the Document. Deprecated.

 o getProcessingInstruction(String)

This returns the first processing instruction for this Document located at the document level (outside the root element) for the supplied target, or null if no such processing instruction exists. Deprecated.

 o getProcessingInstructions()

This will return the list of { Deprecated.

 o getProcessingInstructions(String)

This returns the processing instructions for this Document located at the document level (outside the root element) which have the supplied target. Deprecated.

 o getRootElement()

This will return the root Element for this Document

 o getSerializedForm()

This will return the Document in XML format, usable in an XML document. Deprecated.

 o hashCode()

This returns the hash code for this Document.

 o removeContent(Comment)

This removes the specified Comment.

 o removeContent(ProcessingInstruction)

This removes the specified ProcessingInstruction.

 o removeProcessingInstruction(String)

This will remove the first PI with the specified target. Deprecated.

 o removeProcessingInstructions(String)

This will remove all PIs with the specified target. Deprecated.

 o setContent(List)

This will set all content for the Document.

 o setDocType(DocType)

This will set the {

 o setMixedContent(List)

This will set all content for the Document. Deprecated.

 o setProcessingInstructions(List)

This sets the PIs for this Document to those in the ListDeprecated.

 o setRootElement(Element)

This sets the root {

 o toString()

This returns a String representation of the Document, suitable for debugging.

Variables

 o content
 protected List content
This Document's {@link Comment}s, {@link ProcessingInstruction}s and the root {@link Element}

 o docType
 protected DocType docType
The {@link DocType} declaration

Constructors

 o Document
 protected Document()

Default, no-args constructor for implementations to use if needed.

 o Document
 public Document(Element rootElement,
                 DocType docType)

This will create a new Document, with the supplied {@link Element} as the root element and the supplied {@link DocType} declaration.

Parameters:
rootElement - Element for document root.
docType - DocType declaration.
 o Document
 public Document(Element rootElement)

This will create a new Document, with the supplied {@link Element} as the root element, and no {@link DocType} declaration.

Parameters:
rootElement - Element for document root
 o Document
 public Document(List content,
                 DocType docType)

This will create a new Document, with the supplied list of content, and the supplied {@link DocType} declaration.

Parameters:
content - List of starter content
docType - DocType declaration.
Throws: IllegalAddException
if (1) the List contains more than one Element or objects of illegal types, or (2) if the given docType object is already attached to a document.
 o Document
 public Document(List content)

This will create a new Document, with the supplied list of content, and no {@link DocType} declaration.

Parameters:
content - List of starter content
Throws: IllegalAddException
if the List contains more than one Element or objects of illegal types.

Methods

 o getRootElement
 public Element getRootElement()

This will return the root Element for this Document

Returns:
Element - the document's root element
 o setRootElement
 public Document setRootElement(Element rootElement)

This sets the root {@link Element} for the Document.

Parameters:
rootElement - Element to be new root.
Returns:
Document - modified Document.
Throws: IllegalAddException
if the given rootElement already has a parent.
 o getDocType
 public DocType getDocType()

This will return the {@link DocType} declaration for this Document, or null if none exists.

Returns:
DocType - the DOCTYPE declaration.
 o setDocType
 public Document setDocType(DocType docType)

This will set the {@link 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.

Parameters:
docType - DocType declaration.
Throws: IllegalAddException
if the given docType is already attached to a Document.
 o addContent
 public Document addContent(ProcessingInstruction pi)

Adds the specified PI to the document.

Parameters:
pi - the PI to add.
Returns:
Document this document modified.
Throws: IllegalAddException
if the given processing instruction already has a parent element.
 o addContent
 public Document addContent(Comment comment)

This will add a comment to the Document.

Parameters:
comment - Comment to add.
Returns:
Document - this object modified.
Throws: IllegalAddException
if the given comment already has a parent element.
 o getContent
 public List 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.

Returns:
List - all Document content
 o setContent
 public Document setContent(List newContent)

This will set all content for the Document. The List may contain only objects of type Element, Comment, and ProcessingInstruction; and only one Element that becomes the root. In event of an exception the original content will be unchanged and the items in the added content will be unaltered.

Parameters:
content - the new content
Returns:
the modified Document
Throws: IllegalAddException
if the List contains more than one Element or objects of illegal types.
 o toString
 public String toString()

This returns a String representation of the Document, suitable for debugging. If the XML representation of the Document is desired, {@link org.jdom.output.XMLOutputter#outputString(Document)} should be used.

Returns:
String - information about the Document
Overrides:
toString in class Object
 o equals
 public final boolean equals(Object ob)

This tests for equality of this Document to the supplied Object.

Parameters:
ob - Object to compare to.
Returns:
boolean - whether the Document is equal to the supplied Object.
Overrides:
equals in class Object
 o hashCode
 public final int hashCode()

This returns the hash code for this Document.

Returns:
int - hash code.
Overrides:
hashCode in class Object
 o clone
 public Object clone()

This will return a deep clone of this Document.

Returns:
Object - clone of this Document.
Overrides:
clone in class Object
 o removeContent
 public boolean removeContent(ProcessingInstruction pi)

This removes the specified ProcessingInstruction. If the specified ProcessingInstruction is not a child of this Document, this method does nothing.

Parameters:
child - ProcessingInstruction to delete
Returns:
whether deletion occurred
 o removeContent
 public boolean removeContent(Comment comment)

This removes the specified Comment. If the specified Comment is not a child of this Document, this method does nothing.

Parameters:
comment - Comment to delete
Returns:
whether deletion occurred
 o getSerializedForm
 public final String getSerializedForm()
Note: getSerializedForm() is deprecated. Deprecated in beta7, use XMLOutputter.outputString(Document) instead

This will return the Document in XML format, usable in an XML document.

Returns:
String - the serialized form of the Document.
Throws: RuntimeException
always! This method is not yet implemented. It is also deprecated as of beta 7.
 o getProcessingInstructions
 public List getProcessingInstructions()
Note: getProcessingInstructions() is deprecated. Deprecated in beta7, use getContent() and examine for PIs manually

This will return the list of {@link ProcessingInstruction}s for this Document located at the document level (outside the root element). The returned list is "live" in document order and changes to it affect the document's actual content.

Returns:
List - PIs for document.
 o getProcessingInstructions
 public List getProcessingInstructions(String target)
Note: getProcessingInstructions() is deprecated. Deprecated in beta7, use getContent() and examine for PIs manually

This returns the processing instructions for this Document located at the document level (outside the root element) which have the supplied target. The returned list is "live" in document order and changes to it affect the document's actual content.

Parameters:
target - String target of PI to return.
Returns:
List - all PIs with the specified target.
 o getProcessingInstruction
 public ProcessingInstruction getProcessingInstruction(String target)
Note: getProcessingInstruction() is deprecated. Deprecated in beta7, use getContent() and examine for PIs manually

This returns the first processing instruction for this Document located at the document level (outside the root element) for the supplied target, or null if no such processing instruction exists.

Parameters:
target - String target of PI to return.
Returns:
ProcessingInstruction - the first PI with the specified target, or null if no such PI exists.
 o removeProcessingInstruction
 public boolean removeProcessingInstruction(String target)
Note: removeProcessingInstruction() is deprecated. Deprecated in beta7, use getContent() and remove PIs manually

This will remove the first PI with the specified target.

Parameters:
target - String target of PI to remove.
Returns:
boolean - whether the requested PI was removed.
 o removeProcessingInstructions
 public boolean removeProcessingInstructions(String target)
Note: removeProcessingInstructions() is deprecated. Deprecated in beta7, use getContent() and remove PIs manually

This will remove all PIs with the specified target.

Parameters:
target - String target of PI to remove.
Returns:
boolean - whether the requested PIs were removed.
 o setProcessingInstructions
 public Document setProcessingInstructions(List pis)
Note: setProcessingInstructions() is deprecated. Deprecated in beta7, use getContent() and add PIs manually

This sets the PIs for this Document to those in the List

Parameters:
pis - List of PIs to use.
Returns:
Document - this Document modified.
 o getMixedContent
 public List getMixedContent()
Note: getMixedContent() is deprecated. Deprecated in beta7, use getContent() instead

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.

Returns:
List - all Document content
 o setMixedContent
 public Document setMixedContent(List mixedContent)
Note: setMixedContent() is deprecated. Deprecated in beta7, use setContent(List) instead

This will set all content for the Document. The List may contain only objects of type Element, Comment, and ProcessingInstruction; and only one Element that becomes the root. In event of an exception the original content will be unchanged and the items in the added content will be unaltered.

Parameters:
content - the new mixed content
Returns:
the modified Document
Throws: IllegalAddException
if the List contains more than one Element or objects of illegal types.

All Packages  Class Hierarchy  This Package  Previous  Next  Index