All Packages  Class Hierarchy

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

Index of all Fields and Methods

A

AbstractDOMAdapter(). Constructor for class org.jdom.adapters.AbstractDOMAdapter
addContent(CDATA). Method in class org.jdom.Element

This adds a CDATA section as content to this element.

addContent(Comment). Method in class org.jdom.Document

This will add a comment to the Document.

addContent(Comment). Method in class org.jdom.Element

This adds a comment as content to this element.

addContent(Element). Method in class org.jdom.Element

This adds element content to this element.

addContent(EntityRef). Method in class org.jdom.Element

This adds entity content to this element.

addContent(ProcessingInstruction). Method in class org.jdom.Document

Adds the specified PI to the document.

addContent(ProcessingInstruction). Method in class org.jdom.Element

This adds a processing instruction as content to this element.

addContent(String). Method in class org.jdom.Element

This adds text content to this element.

addContent(Text). Method in class org.jdom.Element

This adds text content to this element.

additionalNamespaces. Variable in class org.jdom.Element
Additional {
addNamespaceDeclaration(Namespace). Method in class org.jdom.Element

This will add a namespace declarations to this element.

append(CDATA). Method in class org.jdom.CDATA

This will append the content of another CDATA node to this node.

append(String). Method in class org.jdom.CDATA

This will append character content to whatever content already exists within this CDATA node.

append(String). Method in class org.jdom.Text

This will append character content to whatever content already exists within this Text node.

append(Text). Method in class org.jdom.Text

This will append the content of another Text node to this node.

appendExternalId(String, String). Method in class org.jdom.input.SAXHandler

Appends an external ID to the internal subset buffer.

atRoot. Variable in class org.jdom.input.SAXHandler
Indicator of where in the document we are
Attribute(). Constructor for class org.jdom.Attribute

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

Attribute(String, String). Constructor for class org.jdom.Attribute

This will create a new Attribute with the specified (local) name and value, and does not place the attribute in a {

attribute(String, String). Method in class org.jdom.input.DefaultJDOMFactory
attribute(String, String). Method in interface org.jdom.input.JDOMFactory

This will create a new Attribute with the specified (local) name and value, and does not place the attribute in a {

Attribute(String, String, int). Constructor for class org.jdom.Attribute

This will create a new Attribute with the specified (local) name, value and type, and does not place the attribute in a {

attribute(String, String, int). Method in class org.jdom.input.DefaultJDOMFactory
attribute(String, String, int). Method in interface org.jdom.input.JDOMFactory

This will create a new Attribute with the specified (local) name, value and type, and does not place the attribute in a {

Attribute(String, String, int, Namespace). Constructor for class org.jdom.Attribute

This will create a new Attribute with the specified (local) name, value, and type, and in the provided {

attribute(String, String, int, Namespace). Method in class org.jdom.input.DefaultJDOMFactory
attribute(String, String, int, Namespace). Method in interface org.jdom.input.JDOMFactory

This will create a new Attribute with the specified (local) name, value, and type, and in the provided {

Attribute(String, String, Namespace). Constructor for class org.jdom.Attribute

This will create a new Attribute with the specified (local) name and value, and in the provided {

attribute(String, String, Namespace). Method in class org.jdom.input.DefaultJDOMFactory
attribute(String, String, Namespace). Method in interface org.jdom.input.JDOMFactory

This will create a new Attribute with the specified (local) name and value, and in the provided {

attributeDecl(String, String, String, String, String). Method in class org.jdom.input.SAXHandler

This handles an attribute declaration in the internal subset

attributes. Variable in class org.jdom.Element
The attributes of the Element.
availableNamespaces. Variable in class org.jdom.input.SAXHandler
The namespaces in scope and actually attached to an element

B

build(Document). Method in class org.jdom.input.DOMBuilder

This will build a JDOM tree from an existing DOM tree.

build(Element). Method in class org.jdom.input.DOMBuilder

This will build a JDOM Element from an existing DOM Element

build(File). Method in class org.jdom.input.DOMBuilder

This builds a document from the supplied filename by constructing a DOM tree and reading information from the DOM to create a JDOM document, a slower approach than SAXBuilder but useful for debugging.

build(File). Method in class org.jdom.input.SAXBuilder

This builds a document from the supplied filename.

build(InputSource). Method in class org.jdom.input.SAXBuilder

This builds a document from the supplied input source.

build(InputStream). Method in class org.jdom.input.DOMBuilder

This builds a document from the supplied input stream by constructing a DOM tree and reading information from the DOM to create a JDOM document, a slower approach than SAXBuilder but useful for debugging.

build(InputStream). Method in class org.jdom.input.SAXBuilder

This builds a document from the supplied input stream.

build(InputStream, String). Method in class org.jdom.input.SAXBuilder

This builds a document from the supplied input stream.

build(Reader). Method in class org.jdom.input.SAXBuilder

This builds a document from the supplied Reader.

build(Reader, String). Method in class org.jdom.input.SAXBuilder

This builds a document from the supplied Reader.

build(String). Method in class org.jdom.input.SAXBuilder

This builds a document from the supplied URI.

build(URL). Method in class org.jdom.input.DOMBuilder

This builds a document from the supplied URL by constructing a DOM tree and reading information from the DOM to create a JDOM document, a slower approach than SAXBuilder but useful for debugging.

build(URL). Method in class org.jdom.input.SAXBuilder

This builds a document from the supplied URL.

BuilderErrorHandler(). Constructor for class org.jdom.input.BuilderErrorHandler

C

canAdd(Object). Method in class org.jdom.filter.ContentFilter

Check to see if the object can be added to the list.

canAdd(Object). Method in class org.jdom.filter.ElementFilter

Only allow the adding of Element objects.

canAdd(Object). Method in interface org.jdom.filter.Filter

Check to see if the object can be added to the list.

canRemove(Object). Method in class org.jdom.filter.ContentFilter

Check to see if the object can be removed from the list.

canRemove(Object). Method in class org.jdom.filter.ElementFilter

Check to see if the object can be removed from the list.

canRemove(Object). Method in interface org.jdom.filter.Filter

Check to see if the object can be removed from the list.

cause. Variable in class org.jdom.JDOMException
A wrapped Throwable
CDATA. Static variable in class org.jdom.filter.ContentFilter
Mask for JDOM CDATA objects
CDATA(). Constructor for class org.jdom.CDATA

This is the protected, no-args constructor standard in all JDOM classes.

CDATA(String). Constructor for class org.jdom.CDATA

This constructor creates a new CDATA node, with the supplied string value as it's character content.

cdata(String). Method in class org.jdom.input.DefaultJDOMFactory
cdata(String). Method in interface org.jdom.input.JDOMFactory

This creates the CDATA with the supplied text.

CDATA_ATTRIBUTE. Static variable in class org.jdom.Attribute

Attribute type: the attribute value is a string.

characters(char[], int, int). Method in class org.jdom.input.SAXHandler

This will report character data (within an element).

checkAttributeName(String). Static method in class org.jdom.Verifier

This will check the supplied name to see if it is legal for use as a JDOM {

checkCDATASection(String). Static method in class org.jdom.Verifier

This will check the supplied data to see if it is legal for use as JDOM {

checkCharacterData(String). Static method in class org.jdom.Verifier

This will check the supplied string to see if it only contains characters allowed by the XML 1.0 specification.

checkCommentData(String). Static method in class org.jdom.Verifier

This will check the supplied data to see if it is legal for use as JDOM {

checkElementName(String). Static method in class org.jdom.Verifier

This will check the supplied name to see if it is legal for use as a JDOM {

checkNamespaceCollision(Attribute, Element). Static method in class org.jdom.Verifier

Check if {

checkNamespaceCollision(Namespace, Attribute). Static method in class org.jdom.Verifier

Check if a {

checkNamespaceCollision(Namespace, Element). Static method in class org.jdom.Verifier

Check if a {

checkNamespaceCollision(Namespace, List). Static method in class org.jdom.Verifier

Check if a {

checkNamespaceCollision(Namespace, Namespace). Static method in class org.jdom.Verifier

Check if two namespaces collide.

checkNamespacePrefix(String). Static method in class org.jdom.Verifier

This will check the supplied name to see if it is legal for use as a JDOM {

checkNamespaceURI(String). Static method in class org.jdom.Verifier

This will check the supplied name to see if it is legal for use as a JDOM {

checkProcessingInstructionTarget(String). Static method in class org.jdom.Verifier

This will check the supplied data to see if it is legal for use as a JDOM {

checkPublicID(String). Static method in class org.jdom.Verifier

This will ensure that the data for a public identifier is legal.

checkSystemLiteral(String). Static method in class org.jdom.Verifier

This will ensure that the data for a system literal is legal.

checkXMLName(String). Static method in class org.jdom.Verifier

This is a utility function for sharing the base process of checking any XML name.

clone(). Method in class org.jdom.Attribute

This will return a clone of this Attribute.

clone(). Method in class org.jdom.CDATA

This will return a clone of this CDATA node, with the same character content, but no parent.

clone(). Method in class org.jdom.Comment

This will return a clone of this Comment.

clone(). Method in class org.jdom.DocType

This will return a clone of this DocType.

clone(). Method in class org.jdom.Document

This will return a deep clone of this Document.

clone(). Method in class org.jdom.Element

This returns a deep clone of this element.

clone(). Method in class org.jdom.EntityRef

This will return a clone of this EntityRef.

clone(). Method in class org.jdom.ProcessingInstruction

This will return a clone of this ProcessingInstruction.

clone(). Method in class org.jdom.Text

This will return a clone of this Text node, with the same character content, but no parent.

clone(). Method in class org.jdom.output.XMLOutputter
Returns a copy of this XMLOutputter.
COMMENT. Static variable in class org.jdom.filter.ContentFilter
Mask for JDOM Comment objects
Comment(). Constructor for class org.jdom.Comment

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

comment(char[], int, int). Method in class org.jdom.input.SAXHandler

This reports that a comments is parsed.

Comment(String). Constructor for class org.jdom.Comment

This creates the comment with the supplied text.

comment(String). Method in class org.jdom.input.DefaultJDOMFactory
comment(String). Method in interface org.jdom.input.JDOMFactory

This creates the comment with the supplied text.

configureContentHandler(SAXHandler). Method in class org.jdom.input.SAXBuilder

This configures the SAXHandler that will be used to build the Document.

configureParser(XMLReader, SAXHandler). Method in class org.jdom.input.SAXBuilder

This configures the XMLReader to be used for reading the XML document.

content. Variable in class org.jdom.Document
This Document's {
content. Variable in class org.jdom.Element
The mixed content of the Element.
ContentFilter(). Constructor for class org.jdom.filter.ContentFilter

Default constructor that allows any legal JDOM objects.

ContentFilter(boolean). Constructor for class org.jdom.filter.ContentFilter

Set whether all JDOM objects are visible or not.

ContentFilter(int). Constructor for class org.jdom.filter.ContentFilter

Filter out JDOM objects according to a filtering mask.

createContentHandler(). Method in class org.jdom.input.SAXBuilder

This creates the SAXHandler that will be used to build the Document.

createDocument(). Method in class org.jdom.adapters.AbstractDOMAdapter

This creates an empty Document object based on a specific parser implementation.

createDocument(). Method in class org.jdom.adapters.CrimsonDOMAdapter

This creates an empty Document object based on a specific parser implementation.

createDocument(). Method in interface org.jdom.adapters.DOMAdapter

This creates an empty Document object based on a specific parser implementation.

createDocument(). Method in class org.jdom.adapters.JAXPDOMAdapter

This creates an empty Document object based on a specific parser implementation.

createDocument(). Method in class org.jdom.adapters.OracleV1DOMAdapter

This creates an empty Document object based on a specific parser implementation.

createDocument(). Method in class org.jdom.adapters.OracleV2DOMAdapter

This creates an empty Document object based on a specific parser implementation.

createDocument(). Method in class org.jdom.adapters.ProjectXDOMAdapter

This creates an empty Document object based on a specific parser implementation.

createDocument(). Method in class org.jdom.adapters.XercesDOMAdapter

This creates an empty Document object based on a specific parser implementation.

createDocument(). Method in class org.jdom.adapters.XML4JDOMAdapter

This creates an empty Document object based on a specific parser implementation.

createDocument(DocType). Method in class org.jdom.adapters.AbstractDOMAdapter

This creates an empty Document object based on a specific parser implementation with the given DOCTYPE.

createDocument(DocType). Method in interface org.jdom.adapters.DOMAdapter

This creates an empty Document object based on a specific parser implementation with the given DOCTYPE.

createNamespaceStack(). Method in class org.jdom.output.XMLOutputter

Factory for making new NamespaceStack objects.

createParser(). Method in class org.jdom.input.SAXBuilder

This creates the XMLReader to be used for reading the XML document.

createParser(). Method in class org.jdom.output.SAXOutputter

Creates a SAX XMLReader.

CrimsonDOMAdapter(). Constructor for class org.jdom.adapters.CrimsonDOMAdapter

D

DataConversionException(String, String). Constructor for class org.jdom.DataConversionException

This will create an Exception indicating that the specified attribute does not exist for the current element.

declaredNamespaces. Variable in class org.jdom.input.SAXHandler
Temporary holder for namespaces that have been declared with startPrefixMapping, but are not yet available on the element
DefaultJDOMFactory(). Constructor for class org.jdom.input.DefaultJDOMFactory
detach(). Method in class org.jdom.Attribute

This detaches the Attribute from its parent, or does nothing if the Attribute has no parent.

detach(). Method in class org.jdom.CDATA

Detaches the CDATA from its parent, or does nothing if the CDATA has no parent.

detach(). Method in class org.jdom.Comment

This detaches the Comment from its parent, or does nothing if the Comment has no parent.

detach(). Method in class org.jdom.Element

This detaches the element from its parent, or does nothing if the element has no parent.

detach(). Method in class org.jdom.EntityRef

This detaches the Entity from its parent, or does nothing if the Entity has no parent.

detach(). Method in class org.jdom.ProcessingInstruction

This detaches the PI from its parent, or does nothing if the PI has no parent.

detach(). Method in class org.jdom.Text

Detaches the Text from its parent, or does nothing if the Text has no parent.

detachRootElement(). Method in class org.jdom.Document

Detach the root {

docType. Variable in class org.jdom.Document
The {
DocType(). Constructor for class org.jdom.DocType

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

docType(String). Method in class org.jdom.input.DefaultJDOMFactory
DocType(String). Constructor for class org.jdom.DocType

This will create the DocType with the specified element name

docType(String). Method in interface org.jdom.input.JDOMFactory

This will create the DocType with the specified element name

docType(String, String). Method in class org.jdom.input.DefaultJDOMFactory
DocType(String, String). Constructor for class org.jdom.DocType

This will create the DocType with the specified element name and reference to an external DTD.

docType(String, String). Method in interface org.jdom.input.JDOMFactory

This will create the DocType with the specified element name and reference to an external DTD.

docType(String, String, String). Method in class org.jdom.input.DefaultJDOMFactory
DocType(String, String, String). Constructor for class org.jdom.DocType

This will create the DocType with the specified element name and a reference to an external DTD.

docType(String, String, String). Method in interface org.jdom.input.JDOMFactory

This will create the DocType with the specified element name and a reference to an external DTD.

DOCUMENT. Static variable in class org.jdom.filter.ContentFilter
Mask for JDOM Document object
document. Variable in class org.jdom.DocType
The document having this DOCTYPE
Document(). Constructor for class org.jdom.Document

Creates a new empty document.

document(Element). Method in class org.jdom.input.DefaultJDOMFactory
Document(Element). Constructor for class org.jdom.Document

This will create a new Document, with the supplied {

document(Element). Method in interface org.jdom.input.JDOMFactory

This will create a new Document, with the supplied {

document(Element, DocType). Method in class org.jdom.input.DefaultJDOMFactory
Document(Element, DocType). Constructor for class org.jdom.Document

This will create a new Document, with the supplied {

document(Element, DocType). Method in interface org.jdom.input.JDOMFactory

This will create a new Document, with the supplied {

Document(List). Constructor for class org.jdom.Document

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

Document(List, DocType). Constructor for class org.jdom.Document

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

DOMBuilder(). Constructor for class org.jdom.input.DOMBuilder

This creates a new DOMBuilder which will attempt to first locate a parser via JAXP, then will try to use a set of default parsers.

DOMBuilder(boolean). Constructor for class org.jdom.input.DOMBuilder

This creates a new DOMBuilder which will attempt to first locate a parser via JAXP, then will try to use a set of default parsers.

DOMBuilder(String). Constructor for class org.jdom.input.DOMBuilder

This creates a new DOMBuilder using the specified DOMAdapter implementation as a way to choose the underlying parser.

DOMBuilder(String, boolean). Constructor for class org.jdom.input.DOMBuilder

This creates a new DOMBuilder using the specified DOMAdapter implementation as a way to choose the underlying parser.

DOMOutputter(). Constructor for class org.jdom.output.DOMOutputter

This creates a new DOMOutputter which will attempt to first locate a DOM implementation to use via JAXP, and if JAXP does not exist or there's a problem, will fall back to the default parser.

DOMOutputter(String). Constructor for class org.jdom.output.DOMOutputter

This creates a new DOMOutputter using the specified DOMAdapter implementation as a way to choose the underlying parser.


E

ELEMENT. Static variable in class org.jdom.filter.ContentFilter
Mask for JDOM Element objects
Element(). Constructor for class org.jdom.Element

This protected constructor is provided in order to support an Element subclass that wants full control over variable initialization.

element(String). Method in class org.jdom.input.DefaultJDOMFactory
Element(String). Constructor for class org.jdom.Element

This will create an Element in no {

element(String). Method in interface org.jdom.input.JDOMFactory

This will create an Element in no {

element(String, Namespace). Method in class org.jdom.input.DefaultJDOMFactory
Element(String, Namespace). Constructor for class org.jdom.Element

This will create a new Element with the supplied (local) name, and define the {

element(String, Namespace). Method in interface org.jdom.input.JDOMFactory

This will create a new Element with the supplied (local) name, and define the {

element(String, String). Method in class org.jdom.input.DefaultJDOMFactory
Element(String, String). Constructor for class org.jdom.Element

This will create a new Element with the supplied (local) name, and specifies the URI of the {

element(String, String). Method in interface org.jdom.input.JDOMFactory

This will create a new Element with the supplied (local) name, and specifies the URI of the {

element(String, String, String). Method in class org.jdom.input.DefaultJDOMFactory
Element(String, String, String). Constructor for class org.jdom.Element

This will create a new Element with the supplied (local) name, and specifies the prefix and URI of the {

element(String, String, String). Method in interface org.jdom.input.JDOMFactory

This will create a new Element with the supplied (local) name, and specifies the prefix and URI of the {

elementDecl(String, String). Method in class org.jdom.input.SAXHandler

Handle an element declaration in a DTD

ElementFilter(). Constructor for class org.jdom.filter.ElementFilter

Filter out the Elements.

ElementFilter(Namespace). Constructor for class org.jdom.filter.ElementFilter

Filter out the Elements with the supplied Namespace.

ElementFilter(String). Constructor for class org.jdom.filter.ElementFilter

Filter out the Elements with the supplied name in any Namespace.

ElementFilter(String, Namespace). Constructor for class org.jdom.filter.ElementFilter

Filter out the Elements with the supplied name and Namespace.

elementName. Variable in class org.jdom.DocType
The element being constrained
endCDATA(). Method in class org.jdom.input.SAXHandler

Report a CDATA section - ignored in SAXBuilder.

endDTD(). Method in class org.jdom.input.SAXHandler

This signifies that the reading of the DTD is complete.

endElement(String, String, String). Method in class org.jdom.input.SAXHandler

Indicates the end of an element (</[element name]>) is reached.

endEntity(String). Method in class org.jdom.input.SAXHandler
endPrefixMapping(String). Method in class org.jdom.input.SAXHandler

This will add the prefix mapping to the JDOM Document object.

ENTITIES_ATTRIBUTE. Static variable in class org.jdom.Attribute

Attribute type: the attribute value is a list of entity names.

ENTITY_ATTRIBUTE. Static variable in class org.jdom.Attribute

Attribute type: the attribute value is the name of an entity.

ENTITYREF. Static variable in class org.jdom.filter.ContentFilter
Mask for JDOM EnitityRef objects
EntityRef(). Constructor for class org.jdom.EntityRef

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

entityRef(String). Method in class org.jdom.input.DefaultJDOMFactory
EntityRef(String). Constructor for class org.jdom.EntityRef

This will create a new EntityRef with the supplied name.

entityRef(String). Method in interface org.jdom.input.JDOMFactory

This will create a new EntityRef with the supplied name.

EntityRef(String, String). Constructor for class org.jdom.EntityRef

This will create a new EntityRef with the supplied name and system id.

entityRef(String, String, String). Method in class org.jdom.input.DefaultJDOMFactory
EntityRef(String, String, String). Constructor for class org.jdom.EntityRef

This will create a new EntityRef with the supplied name, public id, and system id.

entityRef(String, String, String). Method in interface org.jdom.input.JDOMFactory

This will create a new EntityRef with the supplied name, public ID, and system ID.

ENUMERATED_ATTRIBUTE. Static variable in class org.jdom.Attribute

Attribute type: the attribute value is a name token from an enumeration.

equals(Object). Method in class org.jdom.Attribute

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

equals(Object). Method in class org.jdom.CDATA

This tests for equality of this CDATA to the supplied Object, explicitly using the == operator.

equals(Object). Method in class org.jdom.Comment

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

equals(Object). Method in class org.jdom.filter.ContentFilter

Returns true if object is instance of ContentFilter and has the same filtering mask as this one.

equals(Object). Method in class org.jdom.DocType

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

equals(Object). Method in class org.jdom.Document

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

equals(Object). Method in class org.jdom.Element

This tests for equality of this Element to the supplied Object, explicitly using the == operator.

equals(Object). Method in class org.jdom.filter.ElementFilter

Returns true if object is instance of ElementFilter and has the same parent Element, name, and namespace as this filter.

equals(Object). Method in class org.jdom.EntityRef

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

equals(Object). Method in class org.jdom.Namespace

This tests for equality - Two Namespaces are equal if and only if their URIs are byte-for-byte equals.

equals(Object). Method in class org.jdom.ProcessingInstruction

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

equals(Object). Method in class org.jdom.Text

This tests for equality of this Text to the supplied Object, explicitly using the == operator.

error(SAXParseException). Method in class org.jdom.input.BuilderErrorHandler

This method is called in response to an error that has occurred; this indicates that a rule was broken, typically in validation, but that parsing could reasonably continue.

escapeAttributeEntities(String). Method in class org.jdom.output.XMLOutputter

This will take the pre-defined entities in XML 1.0 and convert their character representation to the appropriate entity reference, suitable for XML attributes.

escapeElementEntities(String). Method in class org.jdom.output.XMLOutputter

This will take the three pre-defined entities in XML 1.0 (used specifically in XML elements) and convert their character representation to the appropriate entity reference, suitable for XML element content.

externalEntityDecl(String, String, String). Method in class org.jdom.input.SAXHandler
This is called when the parser encounters an external entity declaration.

F

factory. Variable in class org.jdom.input.SAXBuilder
The factory for creating new JDOM objects
fatalError(SAXParseException). Method in class org.jdom.input.BuilderErrorHandler

This method is called in response to a fatal error; this indicates that a rule has been broken that makes continued parsing either impossible or an almost certain waste of time.

fileToURL(File). Method in class org.jdom.input.SAXBuilder
Imitation of File.toURL(), a JDK 1.2 method, reimplemented here to work with JDK 1.1.
filterMask. Variable in class org.jdom.filter.ContentFilter
The JDOM object mask
flushCharacters(). Method in class org.jdom.input.SAXHandler

This will flush any characters from SAX character calls we've been buffering.


G

getAdditionalNamespaces(). Method in class org.jdom.Element

This will return any namespace declarations on this element that exist, excluding the namespace of the element itself, which can be obtained through {

getAttribute(String). Method in class org.jdom.Element

This returns the attribute for this element with the given name and within no namespace, or null if no such attribute exists.

getAttribute(String, Namespace). Method in class org.jdom.Element

This returns the attribute for this element with the given name and within the given Namespace, or null if no such attribute exists.

getAttributes(). Method in class org.jdom.Element

This returns the complete set of attributes for this element, as a List of Attribute objects in no particular order, or an empty list if there are none.

getAttributeType(). Method in class org.jdom.Attribute

This will return the actual declared type of this Attribute.

getAttributeValue(String). Method in class org.jdom.Element

This returns the attribute value for the attribute with the given name and within no namespace, null if there is no such attribute, and the empty string if the attribute value is empty.

getAttributeValue(String, Namespace). Method in class org.jdom.Element

This returns the attribute value for the attribute with the given name and within the given Namespace, null if there is no such attribute, and the empty string if the attribute value is empty.

getAttributeValue(String, Namespace, String). Method in class org.jdom.Element

This returns the attribute value for the attribute with the given name and within the given Namespace, or the passed-in default if there is no such attribute.

getAttributeValue(String, String). Method in class org.jdom.Element

This returns the attribute value for the attribute with the given name and within no namespace, or the passed-in default if there is no such attribute.

getBooleanValue(). Method in class org.jdom.Attribute

This gets the value of the attribute, in boolean form, and if no conversion can occur, throws a {

getCause(). Method in class org.jdom.JDOMException

This will return the root cause Throwable, or null if one does not exist.

getChild(String). Method in class org.jdom.Element

This returns the first child element within this element with the given local name and belonging to no namespace.

getChild(String, Namespace). Method in class org.jdom.Element

This returns the first child element within this element with the given local name and belonging to the given namespace.

getChildren(). Method in class org.jdom.Element

This returns a List of all the child elements nested directly (one level deep) within this element, as Element objects.

getChildren(String). Method in class org.jdom.Element

This returns a List of all the child elements nested directly (one level deep) within this element with the given local name and belonging to no namespace, returned as Element objects.

getChildren(String, Namespace). Method in class org.jdom.Element

This returns a List of all the child elements nested directly (one level deep) within this element with the given local name and belonging to the given Namespace, returned as Element objects.

getChildText(String). Method in class org.jdom.Element

This convenience method returns the textual content of the named child element, or returns an empty String ("") if the child has no textual content.

getChildText(String, Namespace). Method in class org.jdom.Element

This convenience method returns the textual content of the named child element, or returns null if there's no such child.

getChildTextNormalize(String). Method in class org.jdom.Element

This convenience method returns the normalized textual content of the named child element, or returns null if there's no such child.

getChildTextNormalize(String, Namespace). Method in class org.jdom.Element

This convenience method returns the normalized textual content of the named child element, or returns null if there's no such child.

getChildTextTrim(String). Method in class org.jdom.Element

This convenience method returns the trimmed textual content of the named child element, or returns null if there's no such child.

getChildTextTrim(String, Namespace). Method in class org.jdom.Element

This convenience method returns the trimmed textual content of the named child element, or returns null if there's no such child.

getContent(). Method in class org.jdom.Document

This will return all content for the Document.

getContent(). Method in class org.jdom.Element

This returns the full content of the element as a List which may contain objects of type Text, Element, Comment, ProcessingInstruction, CDATA, and EntityRef.

getContent(Filter). Method in class org.jdom.Document

Return a filtered view of this Document's content.

getContent(Filter). Method in class org.jdom.Element

Return a filter view of this Element's content.

getContentHandler(). Method in class org.jdom.output.SAXOutputter

Returns the registered ContentHandler.

getCurrentElement(). Method in class org.jdom.input.SAXHandler

Returns the being-parsed element.

getData(). Method in class org.jdom.ProcessingInstruction

This will return the raw data from all instructions.

getDeclHandler(). Method in class org.jdom.output.SAXOutputter

Return the registered DeclHandler.

getDocType(). Method in class org.jdom.Document

This will return the {

getDocument(). Method in class org.jdom.Attribute

This retrieves the owning {

getDocument(). Method in class org.jdom.CDATA

This retrieves the owning {

getDocument(). Method in class org.jdom.Comment

This retrieves the owning {

getDocument(). Method in class org.jdom.DocType

This retrieves the owning {

getDocument(). Method in class org.jdom.Element

This retrieves the owning {

getDocument(). Method in class org.jdom.EntityRef

This retrieves the owning {

getDocument(). Method in class org.jdom.transform.JDOMResult
Returns the document produced as result of an XSL Transformation.
getDocument(). Method in class org.jdom.transform.JDOMSource
Returns the source document used by this TRaX source.
getDocument(). Method in class org.jdom.ProcessingInstruction

This retrieves the owning {

getDocument(). Method in class org.jdom.input.SAXHandler

Returns the document.

getDocument(). Method in class org.jdom.Text

This retrieves the owning {

getDocument(File, boolean). Method in class org.jdom.adapters.AbstractDOMAdapter

This creates a new {

getDocument(File, boolean). Method in interface org.jdom.adapters.DOMAdapter

This creates a new Document from a given filename by letting a DOM parser handle parsing from the file.

getDocument(InputStream, boolean). Method in class org.jdom.adapters.AbstractDOMAdapter

This creates a new {

getDocument(InputStream, boolean). Method in class org.jdom.adapters.CrimsonDOMAdapter

This creates a new {

getDocument(InputStream, boolean). Method in interface org.jdom.adapters.DOMAdapter

This creates a new Document from an existing InputStream by letting a DOM parser handle parsing using the supplied stream.

getDocument(InputStream, boolean). Method in class org.jdom.adapters.JAXPDOMAdapter

This creates a new {

getDocument(InputStream, boolean). Method in class org.jdom.adapters.OracleV1DOMAdapter

This creates a new {

getDocument(InputStream, boolean). Method in class org.jdom.adapters.OracleV2DOMAdapter

This creates a new {

getDocument(InputStream, boolean). Method in class org.jdom.adapters.ProjectXDOMAdapter

This creates a new {

getDocument(InputStream, boolean). Method in class org.jdom.adapters.XercesDOMAdapter

This creates a new {

getDocument(InputStream, boolean). Method in class org.jdom.adapters.XML4JDOMAdapter

This creates a new {

getDocumentLocator(). Method in class org.jdom.input.SAXHandler

Provides access to the {

getDoubleValue(). Method in class org.jdom.Attribute

This gets the value of the attribute, in double form, and if no conversion can occur, throws a {

getDTDHandler(). Method in class org.jdom.output.SAXOutputter

Return the registered DTDHandler.

getElementName(). Method in class org.jdom.DocType

This will retrieve the element name being constrained.

getEntityResolver(). Method in class org.jdom.output.SAXOutputter

Return the registered EntityResolver.

getErrorHandler(). Method in class org.jdom.output.SAXOutputter

Return the registered ErrorHandler.

getExpandEntities(). Method in class org.jdom.input.SAXHandler

Returns whether or not entities will be expanded during the build.

getFactory(). Method in class org.jdom.transform.JDOMResult
Returns the custom JDOMFactory used to build the result document.
getFactory(). Method in class org.jdom.input.SAXHandler

Returns the factory used for constructing objects.

getFeature(String). Method in class org.jdom.output.SAXOutputter

This will look up the value of a SAX feature.

getFilterMask(). Method in class org.jdom.filter.ContentFilter

Return current filtering mask.

getFloatValue(). Method in class org.jdom.Attribute

This gets the value of the attribute, in float form, and if no conversion can occur, throws a {

getIgnoringElementContentWhitespace(). Method in class org.jdom.input.SAXHandler

Returns whether or not the parser will elminate whitespace in element content (sometimes known as "ignorable whitespace") when building the document.

getInternalSubset(). Method in class org.jdom.DocType

This returns the data for the internal subset

getIntValue(). Method in class org.jdom.Attribute

This gets the value of the attribute, in int form, and if no conversion can occur, throws a {

getLexicalHandler(). Method in class org.jdom.output.SAXOutputter

Return the registered LexicalHandler.

getLongValue(). Method in class org.jdom.Attribute

This gets the value of the attribute, in long form, and if no conversion can occur, throws a {

getMessage(). Method in class org.jdom.JDOMException

This returns the message for the Exception.

getName(). Method in class org.jdom.Attribute

This will retrieve the local name of the Attribute.

getName(). Method in class org.jdom.Element

This returns the (local) name of the Element, without any namespace prefix, if one exists.

getName(). Method in class org.jdom.EntityRef

This returns the name of the EntityRef.

getNames(). Method in class org.jdom.ProcessingInstruction

This will return a List containing the names of the "attribute" style pieces of name/value pairs in this PI's data.

getNamespace(). Method in class org.jdom.Attribute

This will return this Attribute's {

getNamespace(). Method in class org.jdom.Element

This will return this Element's {

getNamespace(String). Method in class org.jdom.Element

This returns the Namespace in scope on this element for the given prefix (this involves searching up the tree, so the results depend on the current location of the element).

getNamespace(String). Static method in class org.jdom.Namespace

This will retrieve (if in existence) or create (if not) a Namespace for the supplied URI, and make it usable as a default namespace, as no prefix is supplied.

getNamespace(String, String). Static method in class org.jdom.Namespace

This will retrieve (if in existence) or create (if not) a Namespace for the supplied prefix and URI.

getNamespacePrefix(). Method in class org.jdom.Attribute

This will retrieve the namespace prefix of the Attribute.

getNamespacePrefix(). Method in class org.jdom.Element

This returns the namespace prefix of the Element, if one exists.

getNamespaceURI(). Method in class org.jdom.Attribute

This returns the URI mapped to this Attribute's prefix.

getNamespaceURI(). Method in class org.jdom.Element

This returns the URI mapped to this Element's prefix (or the default namespace if no prefix).

getParent(). Method in class org.jdom.Attribute

This will return the parent of this Attribute.

getParent(). Method in class org.jdom.CDATA

This will return the parent of this CDATA node, which is always a JDOM {

getParent(). Method in class org.jdom.Comment

This will return the parent of this Comment.

getParent(). Method in class org.jdom.Element

This will return the parent of this Element.

getParent(). Method in class org.jdom.EntityRef

This will return the parent of this EntityRef.

getParent(). Method in class org.jdom.ProcessingInstruction

This will return the parent of this ProcessingInstruction.

getParent(). Method in class org.jdom.Text

This will return the parent of this Text node, which is always a JDOM {

getPrefix(). Method in class org.jdom.Namespace

This returns the prefix mapped to this Namespace.

getProperty(String). Method in class org.jdom.output.SAXOutputter

This will look up the value of a SAX property.

getPublicID(). Method in class org.jdom.DocType

This will retrieve the public ID of an externally referenced DTD, or an empty String if none is referenced.

getPublicID(). Method in class org.jdom.EntityRef

This will return the publid ID of this EntityRef.

getQualifiedName(). Method in class org.jdom.Attribute

This will retrieve the qualified name of the Attribute.

getQualifiedName(). Method in class org.jdom.Element

This returns the full name of the Element, in the form [namespacePrefix]:[localName].

getRootElement(). Method in class org.jdom.Document

This will return the root Element for this Document

getSystemID(). Method in class org.jdom.DocType

This will retrieve the system ID of an externally referenced DTD, or an empty String if none is referenced.

getSystemID(). Method in class org.jdom.EntityRef

This will return the system ID of this EntityRef.

getTarget(). Method in class org.jdom.ProcessingInstruction

This will retrieve the target of the PI.

getText(). Method in class org.jdom.CDATA

This returns the value of this CDATA node as a Java String.

getText(). Method in class org.jdom.Comment

This returns the textual data within the Comment.

getText(). Method in class org.jdom.Element

This returns the textual content directly held under this element.

getText(). Method in class org.jdom.Text

This returns the value of this Text node as a Java String.

getTextNormalize(). Method in class org.jdom.CDATA

This returns the textual content with all surrounding whitespace removed and internal whitespace normalized to a single space.

getTextNormalize(). Method in class org.jdom.Element

This returns the textual content of this element with all surrounding whitespace removed and internal whitespace normalized to a single space.

getTextNormalize(). Method in class org.jdom.Text

This returns the textual content with all surrounding whitespace removed and internal whitespace normalized to a single space.

getTextTrim(). Method in class org.jdom.CDATA

This returns the textual content with all surrounding whitespace removed.

getTextTrim(). Method in class org.jdom.Element

This returns the textual content of this element with all surrounding whitespace removed.

getTextTrim(). Method in class org.jdom.Text

This returns the textual content with all surrounding whitespace removed.

getURI(). Method in class org.jdom.Namespace

This returns the namespace URI for this Namespace.

getValue(). Method in class org.jdom.Attribute

This will return the actual textual value of this Attribute.

getValue(String). Method in class org.jdom.ProcessingInstruction

This will return the value for a specific name/value pair on the PI.

getXMLReader(). Method in class org.jdom.transform.JDOMSource
Returns the XMLReader to be used for the Source.

H

hasChildren(). Method in class org.jdom.Element

Test whether this element has a child element.

hashCode(). Method in class org.jdom.Attribute

This returns the hash code for this Attribute.

hashCode(). Method in class org.jdom.CDATA

This will generate a hash code for this node.

hashCode(). Method in class org.jdom.Comment

This returns the hash code for this Comment.

hashCode(). Method in class org.jdom.DocType

This returns the hash code for this DocType.

hashCode(). Method in class org.jdom.Document

This returns the hash code for this Document.

hashCode(). Method in class org.jdom.Element

This returns the hash code for this Element.

hashCode(). Method in class org.jdom.EntityRef

This returns the hash code for this Entity.

hashCode(). Method in class org.jdom.Namespace

This returns a probably unique hash code for the Namespace.

hashCode(). Method in class org.jdom.ProcessingInstruction

This returns the hash code for this ProcessingInstruction.

hashCode(). Method in class org.jdom.Text

This will generate a hash code for this node.

hasRootElement(). Method in class org.jdom.Document

This will return true if this document has a root element, false otherwise.


I

ID_ATTRIBUTE. Static variable in class org.jdom.Attribute

Attribute type: the attribute value is a unique identifier.

IDREF_ATTRIBUTE. Static variable in class org.jdom.Attribute

Attribute type: the attribute value is a reference to a unique identifier.

IDREFS_ATTRIBUTE. Static variable in class org.jdom.Attribute

Attribute type: the attribute value is a list of references to unique identifiers.

ignorableWhitespace(char[], int, int). Method in class org.jdom.input.SAXHandler

Capture ignorable whitespace as text.

IllegalAddException(Document, Comment, String). Constructor for class org.jdom.IllegalAddException

This will create an Exception indicating that the addition of the {

IllegalAddException(Document, DocType, String). Constructor for class org.jdom.IllegalAddException

This will create an Exception indicating that the addition of the {

IllegalAddException(Document, Element, String). Constructor for class org.jdom.IllegalAddException

This will create an Exception indicating that the addition of the {

IllegalAddException(Document, ProcessingInstruction, String). Constructor for class org.jdom.IllegalAddException

This will create an Exception indicating that the addition of the {

IllegalAddException(Element, Attribute, String). Constructor for class org.jdom.IllegalAddException

This will create an Exception indicating that the addition of the {

IllegalAddException(Element, CDATA, String). Constructor for class org.jdom.IllegalAddException

This will create an Exception indicating that the addition of the {

IllegalAddException(Element, Comment, String). Constructor for class org.jdom.IllegalAddException

This will create an Exception indicating that the addition of the {

IllegalAddException(Element, Element, String). Constructor for class org.jdom.IllegalAddException

This will create an Exception indicating that the addition of the {

IllegalAddException(Element, EntityRef, String). Constructor for class org.jdom.IllegalAddException

This will create an Exception indicating that the addition of the {

IllegalAddException(Element, Namespace, String). Constructor for class org.jdom.IllegalAddException

This will create an Exception indicating that the addition of the {

IllegalAddException(Element, ProcessingInstruction, String). Constructor for class org.jdom.IllegalAddException

This will create an Exception indicating that the addition of the {

IllegalAddException(Element, Text, String). Constructor for class org.jdom.IllegalAddException

This will create an Exception indicating that the addition of the {

IllegalAddException(String). Constructor for class org.jdom.IllegalAddException

This will create an Exception with the specified error message.

IllegalDataException(String, String). Constructor for class org.jdom.IllegalDataException

This will create an Exception indicating that the specified data is illegal for the construct it was supplied to.

IllegalDataException(String, String, String). Constructor for class org.jdom.IllegalDataException

This will create an Exception indicating that the specified data is illegal for the construct it was supplied to.

IllegalNameException(String, String). Constructor for class org.jdom.IllegalNameException

This will create an Exception indicating that the specified name is illegal for the construct it was supplied to.

IllegalNameException(String, String, String). Constructor for class org.jdom.IllegalNameException

This will create an Exception indicating that the specified name is illegal for the construct it was supplied to.

IllegalTargetException(String). Constructor for class org.jdom.IllegalTargetException

This will create an Exception indicating that the specified target is illegal for the {

IllegalTargetException(String, String). Constructor for class org.jdom.IllegalTargetException

This will create an Exception indicating that the specified target is illegal for the {

inCDATA. Variable in class org.jdom.input.SAXHandler
Indicator of whether we are in a CDATA
indent(Writer). Method in class org.jdom.output.XMLOutputter

This will print indents (only if the newlines flag was set to true, and indent is non-null).

indent(Writer, int). Method in class org.jdom.output.XMLOutputter

This will print indents (only if the newlines flag was set to true, and indent is non-null).

inDTD. Variable in class org.jdom.input.SAXHandler
Indicator of whether we are in the DocType.
inInternalSubset. Variable in class org.jdom.input.SAXHandler
Indicator of whether we are in the internal subset
initCause(Throwable). Method in class org.jdom.JDOMException

Intializes the cause of this exception to be the specified value.

internalEntityDecl(String, String). Method in class org.jdom.input.SAXHandler

Handle an internal entity declaration in a DTD.

internalSubset. Variable in class org.jdom.DocType
The internal subset of the DOCTYPE
isAncestor(Element). Method in class org.jdom.Element

Determines if this element is the ancestor of another element.

isRootElement(). Method in class org.jdom.Element

This returns a boolean value indicating whether this Element is a root Element for a JDOM {

isXMLCharacter(char). Static method in class org.jdom.Verifier

This is a utility function for determining whether a specified character is a character according to production 2 of the XML 1.0 specification.

isXMLCombiningChar(char). Static method in class org.jdom.Verifier

This is a utility function for determining whether a specified character is a combining character according to production 87 of the XML 1.0 specification.

isXMLDigit(char). Static method in class org.jdom.Verifier

This is a utility function for determining whether a specified Unicode character is a digit according to production 88 of the XML 1.0 specification.

isXMLExtender(char). Static method in class org.jdom.Verifier

This is a utility function for determining whether a specified character is an extender according to production 88 of the XML 1.0 specification.

isXMLLetter(char). Static method in class org.jdom.Verifier

This is a utility function for determining whether a specified character is a letter according to production 84 of the XML 1.0 specification.

isXMLLetterOrDigit(char). Static method in class org.jdom.Verifier

This is a utility function for determining whether a specified character is a letter or digit according to productions 84 and 88 of the XML 1.0 specification.

isXMLNameCharacter(char). Static method in class org.jdom.Verifier

This is a utility function for determining whether a specified character is a name character according to production 4 of the XML 1.0 specification.

isXMLNameStartCharacter(char). Static method in class org.jdom.Verifier

This is a utility function for determining whether a specified character is a legal name start character according to production 5 of the XML 1.0 specification.


J

JAXPDOMAdapter(). Constructor for class org.jdom.adapters.JAXPDOMAdapter
JDOM_FEATURE. Static variable in class org.jdom.transform.JDOMResult
If {
JDOM_FEATURE. Static variable in class org.jdom.transform.JDOMSource
If {
JDOMException(). Constructor for class org.jdom.JDOMException

This will create an Exception.

JDOMException(String). Constructor for class org.jdom.JDOMException

This will create an Exception with the given message.

JDOMException(String, Throwable). Constructor for class org.jdom.JDOMException

This will create an Exception with the given message and wrap another Exception.

JDOMResult(). Constructor for class org.jdom.transform.JDOMResult
Default empty constructor.
JDOMSource(Document). Constructor for class org.jdom.transform.JDOMSource
Creates a JDOM TRaX source wrapping a JDOM document.

M

main(String[]). Static method in class org.jdom.Verifier
makeWriter(OutputStream). Method in class org.jdom.output.XMLOutputter

Get an OutputStreamWriter, using prefered encoding (see {

makeWriter(OutputStream, String). Method in class org.jdom.output.XMLOutputter

Get an OutputStreamWriter, use specified encoding.

mapData. Variable in class org.jdom.ProcessingInstruction
The data for the PI in name/value pairs
matches(Object). Method in class org.jdom.filter.ContentFilter

Check to see if the object matches according to the filter mask.

matches(Object). Method in class org.jdom.filter.ElementFilter

Check to see if the object matches a predefined set of rules.

matches(Object). Method in interface org.jdom.filter.Filter

Check to see if the object matches a predefined set of rules.


N

name. Variable in class org.jdom.Attribute
The local name of the Attribute
name. Variable in class org.jdom.Element
The local name of the Element
name. Variable in class org.jdom.filter.ElementFilter
The element name
name. Variable in class org.jdom.EntityRef
The name of the EntityRef
namespace. Variable in class org.jdom.Attribute
The {
namespace. Variable in class org.jdom.Element
The {
namespace. Variable in class org.jdom.filter.ElementFilter
The element namespace
newline(Writer). Method in class org.jdom.output.XMLOutputter

This will print a new line only if the newlines flag was set to true.

NMTOKEN_ATTRIBUTE. Static variable in class org.jdom.Attribute

Attribute type: the attribute value is a name token.

NMTOKENS_ATTRIBUTE. Static variable in class org.jdom.Attribute

Attribute type: the attribute value is a list of name tokens.

NO_NAMESPACE. Static variable in class org.jdom.Namespace
Define a Namespace for when not in a namespace
normalizeString(String). Static method in class org.jdom.Text

This returns a new string with all surrounding whitespace removed and internal whitespace normalized to a single space.

NOTATION_ATTRIBUTE. Static variable in class org.jdom.Attribute

Attribute type: the attribute value is the name of a notation.

notationDecl(String, String, String). Method in class org.jdom.input.SAXHandler

Handle the declaration of a Notation in a DTD


O

OracleV1DOMAdapter(). Constructor for class org.jdom.adapters.OracleV1DOMAdapter
OracleV2DOMAdapter(). Constructor for class org.jdom.adapters.OracleV2DOMAdapter
output(Attribute). Method in class org.jdom.output.DOMOutputter

This converts the JDOM Attribute parameter to a DOM Attr, returning the DOM version.

output(Attribute, Document). Method in class org.jdom.output.DOMOutputter
output(CDATA, OutputStream). Method in class org.jdom.output.XMLOutputter

Print out a {

output(CDATA, Writer). Method in class org.jdom.output.XMLOutputter

Print out a {

output(Comment, OutputStream). Method in class org.jdom.output.XMLOutputter

Print out a {

output(Comment, Writer). Method in class org.jdom.output.XMLOutputter

Print out a {

output(DocType, OutputStream). Method in class org.jdom.output.XMLOutputter

Print out the {

output(DocType, Writer). Method in class org.jdom.output.XMLOutputter

Print out the {

output(Document). Method in class org.jdom.output.DOMOutputter

This converts the JDOM Document parameter to a DOM Document, returning the DOM version.

output(Document). Method in class org.jdom.output.SAXOutputter

This will output the JDOM Document, firing off the SAX events that have been registered.

output(Document, OutputStream). Method in class org.jdom.output.XMLOutputter

This will print the Document to the given output stream.

output(Document, Writer). Method in class org.jdom.output.XMLOutputter

This will print the Document to the given Writer.

output(Element). Method in class org.jdom.output.DOMOutputter

This converts the JDOM Element parameter to a DOM Element, returning the DOM version.

output(Element, Document, NamespaceStack). Method in class org.jdom.output.DOMOutputter
output(Element, OutputStream). Method in class org.jdom.output.XMLOutputter

Print out an {

output(Element, Writer). Method in class org.jdom.output.XMLOutputter

Print out an {

output(EntityRef, OutputStream). Method in class org.jdom.output.XMLOutputter

Print out a {

output(EntityRef, Writer). Method in class org.jdom.output.XMLOutputter

Print out a {

output(List, OutputStream). Method in class org.jdom.output.XMLOutputter

This will handle printing out a list of nodes.

output(List, Writer). Method in class org.jdom.output.XMLOutputter

This will handle printing out a list of nodes.

output(ProcessingInstruction, OutputStream). Method in class org.jdom.output.XMLOutputter

Print out a {

output(ProcessingInstruction, Writer). Method in class org.jdom.output.XMLOutputter

Print out a {

output(String, OutputStream). Method in class org.jdom.output.XMLOutputter

Print out a {

output(String, Writer). Method in class org.jdom.output.XMLOutputter

Print out a {

output(Text, OutputStream). Method in class org.jdom.output.XMLOutputter

Print out a {

output(Text, Writer). Method in class org.jdom.output.XMLOutputter

Print out a {

outputElementContent(Element, OutputStream). Method in class org.jdom.output.XMLOutputter
This will handle printing out an {
outputElementContent(Element, Writer). Method in class org.jdom.output.XMLOutputter

This will handle printing out an {

outputString(CDATA). Method in class org.jdom.output.XMLOutputter

Return a string representing a CDATA node.

outputString(Comment). Method in class org.jdom.output.XMLOutputter

Return a string representing a comment.

outputString(DocType). Method in class org.jdom.output.XMLOutputter

Return a string representing a DocType.

outputString(Document). Method in class org.jdom.output.XMLOutputter

Return a string representing a document.

outputString(Element). Method in class org.jdom.output.XMLOutputter

Return a string representing an element.

outputString(EntityRef). Method in class org.jdom.output.XMLOutputter

Return a string representing an entity.

outputString(List). Method in class org.jdom.output.XMLOutputter

Return a string representing a list of nodes.

outputString(ProcessingInstruction). Method in class org.jdom.output.XMLOutputter

Return a string representing a PI.

outputString(String). Method in class org.jdom.output.XMLOutputter

Return a string representing (with trimming, normalizatio, and escaping possibly applied) a String.

outputString(Text). Method in class org.jdom.output.XMLOutputter

Return a string representing a Text node.


P

parent. Variable in class org.jdom.Attribute
Parent element, or null if none
parent. Variable in class org.jdom.CDATA
This CDATA node's parent.
parent. Variable in class org.jdom.Comment
Parent element, document, or null if none
parent. Variable in class org.jdom.Element
Parent element, document, or null if none
parent. Variable in class org.jdom.EntityRef
Parent element or null if none
parent. Variable in class org.jdom.ProcessingInstruction
Parent element, document, or null if none
parent. Variable in class org.jdom.Text
This Text node's parent.
parseArgs(String[], int). Method in class org.jdom.output.XMLOutputter

Parse command-line arguments of the form -omitEncoding -indentSize 3 ...

PI. Static variable in class org.jdom.filter.ContentFilter
Mask for JDOM ProcessingInstruction objects
previousCDATA. Variable in class org.jdom.input.SAXHandler
Indicator of whether we previously where in a CDATA
printAttributes(List, Element, Writer, XMLOutputter. NamespaceStack). Method in class org.jdom.output.XMLOutputter

This will handle printing of a {

printCDATA(CDATA, Writer). Method in class org.jdom.output.XMLOutputter

This will handle printing of {

printComment(Comment, Writer). Method in class org.jdom.output.XMLOutputter

This will handle printing of comments.

printContent(List, Writer, int, XMLOutputter. NamespaceStack). Method in class org.jdom.output.XMLOutputter

This will handle printing of a {

printContentRange(List, int, int, Writer, int, XMLOutputter. NamespaceStack). Method in class org.jdom.output.XMLOutputter

This will handle printing of content within a given range.

printDeclaration(Document, Writer, String). Method in class org.jdom.output.XMLOutputter

This will handle printing of the declaration.

printDocType(DocType, Writer). Method in class org.jdom.output.XMLOutputter

This handle printing the DOCTYPE declaration if one exists.

printElement(Element, Writer, int, XMLOutputter. NamespaceStack). Method in class org.jdom.output.XMLOutputter

This will handle printing of a {

printElementContent(Element, Writer, int, XMLOutputter. NamespaceStack). Method in class org.jdom.output.XMLOutputter

This will handle printing of a {

printEntityRef(EntityRef, Writer). Method in class org.jdom.output.XMLOutputter

This will handle printing a {

printProcessingInstruction(ProcessingInstruction, Writer). Method in class org.jdom.output.XMLOutputter

This will handle printing of processing instructions.

printStackTrace(). Method in class org.jdom.JDOMException

This prints the stack trace of the Exception.

printStackTrace(PrintStream). Method in class org.jdom.JDOMException

This prints the stack trace of the Exception to the given PrintStream.

printStackTrace(PrintWriter). Method in class org.jdom.JDOMException

This prints the stack trace of the Exception to the given PrintWriter.

printString(String, Writer). Method in class org.jdom.output.XMLOutputter
This will handle printing a string.
printText(Text, Writer). Method in class org.jdom.output.XMLOutputter

This will handle printing of {

printTextRange(List, int, int, Writer). Method in class org.jdom.output.XMLOutputter

This will handle printing of a sequence of {

ProcessingInstruction(). Constructor for class org.jdom.ProcessingInstruction

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

processingInstruction(String, Map). Method in class org.jdom.input.DefaultJDOMFactory
processingInstruction(String, Map). Method in interface org.jdom.input.JDOMFactory

This will create a new ProcessingInstruction with the specified target and data.

ProcessingInstruction(String, Map). Constructor for class org.jdom.ProcessingInstruction

This will create a new ProcessingInstruction with the specified target and data.

processingInstruction(String, String). Method in class org.jdom.input.DefaultJDOMFactory
processingInstruction(String, String). Method in interface org.jdom.input.JDOMFactory

This will create a new ProcessingInstruction with the specified target and data.

ProcessingInstruction(String, String). Constructor for class org.jdom.ProcessingInstruction

This will create a new ProcessingInstruction with the specified target and data.

processingInstruction(String, String). Method in class org.jdom.input.SAXHandler

This will indicate that a processing instruction has been encountered.

ProjectXDOMAdapter(). Constructor for class org.jdom.adapters.ProjectXDOMAdapter
publicID. Variable in class org.jdom.DocType
The public ID of the DOCTYPE
publicID. Variable in class org.jdom.EntityRef
The PublicID of the EntityRef

R

rawData. Variable in class org.jdom.ProcessingInstruction
The data for the PI as a String
removeAttribute(Attribute). Method in class org.jdom.Element

This removes the supplied Attribute should it exist.

removeAttribute(String). Method in class org.jdom.Element

This removes the attribute with the given name and within no namespace.

removeAttribute(String, Namespace). Method in class org.jdom.Element

This removes the attribute with the given name and within the given Namespace.

removeChild(String). Method in class org.jdom.Element

This removes the first child element (one level deep) with the given local name and belonging to no namespace.

removeChild(String, Namespace). Method in class org.jdom.Element

This removes the first child element (one level deep) with the given local name and belonging to the given namespace.

removeChildren(). Method in class org.jdom.Element

This removes all child elements.

removeChildren(String). Method in class org.jdom.Element

This removes all child elements (one level deep) with the given local name and belonging to no namespace.

removeChildren(String, Namespace). Method in class org.jdom.Element

This removes all child elements (one level deep) with the given local name and belonging to the given namespace.

removeContent(CDATA). Method in class org.jdom.Element

This removes the specified CDATA.

removeContent(Comment). Method in class org.jdom.Document

This removes the specified Comment.

removeContent(Comment). Method in class org.jdom.Element

This removes the specified Comment.

removeContent(Element). Method in class org.jdom.Element

This removes the specified Element.

removeContent(EntityRef). Method in class org.jdom.Element

This removes the specified EntityRef.

removeContent(ProcessingInstruction). Method in class org.jdom.Document

This removes the specified ProcessingInstruction.

removeContent(ProcessingInstruction). Method in class org.jdom.Element

This removes the specified ProcessingInstruction.

removeContent(Text). Method in class org.jdom.Element

This removes the specified Text.

removeNamespaceDeclaration(Namespace). Method in class org.jdom.Element

This will remove a namespace declarations from this element.

removeValue(String). Method in class org.jdom.ProcessingInstruction

This will remove the name/value pair with the specified name.


S

SAXBuilder(). Constructor for class org.jdom.input.SAXBuilder

Creates a new SAXBuilder which will attempt to first locate a parser via JAXP, then will try to use a set of default SAX Drivers.

SAXBuilder(boolean). Constructor for class org.jdom.input.SAXBuilder

Creates a new SAXBuilder which will attempt to first locate a parser via JAXP, then will try to use a set of default SAX Drivers.

SAXBuilder(String). Constructor for class org.jdom.input.SAXBuilder

Creates a new SAXBuilder using the specified SAX parser.

SAXBuilder(String, boolean). Constructor for class org.jdom.input.SAXBuilder

Creates a new SAXBuilder using the specified SAX parser.

SAXHandler(). Constructor for class org.jdom.input.SAXHandler

This will create a new SAXHandler that listens to SAX events and creates a JDOM Document.

SAXHandler(Document). Constructor for class org.jdom.input.SAXHandler

This will set the Document to use.

SAXHandler(JDOMFactory). Constructor for class org.jdom.input.SAXHandler

This will create a new SAXHandler that listens to SAX events and creates a JDOM Document.

SAXOutputter(). Constructor for class org.jdom.output.SAXOutputter

This will create a SAXOutputter without any registered handler.

SAXOutputter(ContentHandler). Constructor for class org.jdom.output.SAXOutputter

This will create a SAXOutputter with the specified ContentHandler.

SAXOutputter(ContentHandler, ErrorHandler, DTDHandler, EntityResolver). Constructor for class org.jdom.output.SAXOutputter

This will create a SAXOutputter with the specified SAX2 handlers.

SAXOutputter(ContentHandler, ErrorHandler, DTDHandler, EntityResolver, LexicalHandler). Constructor for class org.jdom.output.SAXOutputter

This will create a SAXOutputter with the specified SAX2 handlers.

setAttribute(Attribute). Method in class org.jdom.Element

This sets an attribute value for this element.

setAttribute(String, String). Method in class org.jdom.Element

This sets an attribute value for this element.

setAttribute(String, String, Namespace). Method in class org.jdom.Element

This sets an attribute value for this element.

setAttributes(List). Method in class org.jdom.Element

This sets the attributes of the element.

setAttributeType(int). Method in class org.jdom.Attribute

This will set the type of the Attribute.

setCDATAVisible(boolean). Method in class org.jdom.filter.ContentFilter

Set visiblity of CDATA objects.

setChildren(List). Method in class org.jdom.Element

This sets the content of the element the same as {

setCommentVisible(boolean). Method in class org.jdom.filter.ContentFilter

Set visiblity of Comment objects.

setContent(List). Method in class org.jdom.Document

This sets the content of the Document.

setContent(List). Method in class org.jdom.Element

This sets the content of the element.

setContentHandler(ContentHandler). Method in class org.jdom.output.SAXOutputter

This will set the ContentHandler.

setData(Map). Method in class org.jdom.ProcessingInstruction

This will set the name/value pairs within the passed Map as the pairs for the data of this PI.

setData(String). Method in class org.jdom.ProcessingInstruction

This will set the raw data for the PI.

setDeclHandler(DeclHandler). Method in class org.jdom.output.SAXOutputter

This will set the DeclHandler.

setDefaultMask(). Method in class org.jdom.filter.ContentFilter

Set this filter to allow all legal JDOM objects.

setDocType(DocType). Method in class org.jdom.Document

This will set the {

setDocument(Document). Method in class org.jdom.Comment

This sets the {

setDocument(Document). Method in class org.jdom.DocType

This sets the {

setDocument(Document). Method in class org.jdom.Element

This sets the {

setDocument(Document). Method in class org.jdom.transform.JDOMResult
Sets the document produced as result of an XSL Transformation.
setDocument(Document). Method in class org.jdom.transform.JDOMSource
Sets the source document used by this TRaX source.
setDocument(Document). Method in class org.jdom.ProcessingInstruction

This sets the {

setDocumentContent(). Method in class org.jdom.filter.ContentFilter

Set filter to match only JDOM objects that are legal document content.

setDocumentLocator(Locator). Method in class org.jdom.input.SAXHandler

Receives an object for locating the origin of SAX document events.

setDTDHandler(DTDHandler). Method in class org.jdom.input.SAXBuilder

This sets custom DTDHandler for the Builder.

setDTDHandler(DTDHandler). Method in class org.jdom.output.SAXOutputter

This will set the DTDHandler.

setElementContent(). Method in class org.jdom.filter.ContentFilter

Set filter to match only JDOM objects that are legal element content.

setElementName(String). Method in class org.jdom.DocType

This will set the root element name declared by this DOCTYPE declaration.

setElementVisible(boolean). Method in class org.jdom.filter.ContentFilter

Set visiblity of Element objects.

setEncoding(String). Method in class org.jdom.output.XMLOutputter

Sets the output encoding.

setEntityRefVisible(boolean). Method in class org.jdom.filter.ContentFilter

Set visiblity of EntityRef objects.

setEntityResolver(EntityResolver). Method in class org.jdom.input.SAXBuilder

This sets custom EntityResolver for the Builder.

setEntityResolver(EntityResolver). Method in class org.jdom.output.SAXOutputter

This will set the EntityResolver.

setErrorHandler(ErrorHandler). Method in class org.jdom.input.SAXBuilder

This sets custom ErrorHandler for the Builder.

setErrorHandler(ErrorHandler). Method in class org.jdom.output.SAXOutputter

This will set the ErrorHandler.

setExpandEmptyElements(boolean). Method in class org.jdom.output.XMLOutputter

This will set whether empty elements are expanded from <tagName/> to <tagName></tagName>.

setExpandEntities(boolean). Method in class org.jdom.input.SAXBuilder

This sets whether or not to expand entities for the builder.

setExpandEntities(boolean). Method in class org.jdom.input.SAXHandler

This sets whether or not to expand entities during the build.

setFactory(JDOMFactory). Method in class org.jdom.input.DOMBuilder
setFactory(JDOMFactory). Method in class org.jdom.transform.JDOMResult
Sets a custom JDOMFactory to use when building the result document.
setFactory(JDOMFactory). Method in class org.jdom.input.SAXBuilder
setFeature(String, boolean). Method in class org.jdom.input.SAXBuilder

This sets a feature on the SAX parser.

setFeature(String, boolean). Method in class org.jdom.output.SAXOutputter

This will set the state of a SAX feature.

setFilterMask(int). Method in class org.jdom.filter.ContentFilter

Set filtering mask.

setHandler(ContentHandler). Method in class org.jdom.transform.JDOMResult
Sets the target to be a SAX2 ContentHandler.
setIgnoringElementContentWhitespace(boolean). Method in class org.jdom.input.SAXBuilder

Specifies whether or not the parser should elminate whitespace in element content (sometimes known as "ignorable whitespace") when building the document.

setIgnoringElementContentWhitespace(boolean). Method in class org.jdom.input.SAXHandler

Specifies whether or not the parser should elminate whitespace in element content (sometimes known as "ignorable whitespace") when building the document.

setIndent(boolean). Method in class org.jdom.output.XMLOutputter

Set the indent on or off, newlines must be set to true for indentation to actually occur.

setIndent(int). Method in class org.jdom.output.XMLOutputter

This will set the indent String's size; a size of 4 would result in the indentation being equivalent to the String "    " (four spaces).

setIndent(String). Method in class org.jdom.output.XMLOutputter

This will set the indent String to use; this is usually a String of empty spaces.

setIndentLevel(int). Method in class org.jdom.output.XMLOutputter

Set the initial indentation level.

setIndentSize(int). Method in class org.jdom.output.XMLOutputter

This will set the indent String's size; an indentSize of 4 would result in the indentation being equivalent to the String "    " (four spaces).

setInputSource(InputSource). Method in class org.jdom.transform.JDOMSource
Sets the SAX InputSource to be used for the Source.
setInternalSubset(DocumentType, String). Method in class org.jdom.adapters.AbstractDOMAdapter

This attempts to change the DocumentType to have the given internal DTD subset value.

setInternalSubset(String). Method in class org.jdom.DocType

This sets the data for the internal subset.

setLexicalHandler(LexicalHandler). Method in class org.jdom.transform.JDOMResult
Sets the SAX2 LexicalHandler for the output.
setLexicalHandler(LexicalHandler). Method in class org.jdom.output.SAXOutputter

This will set the LexicalHandler.

setLineSeparator(String). Method in class org.jdom.output.XMLOutputter

This will set the newline separator (lineSeparator).

setName(String). Method in class org.jdom.Attribute

This sets the local name of the Attribute.

setName(String). Method in class org.jdom.Element

This sets the (local) name of the Element.

setName(String). Method in class org.jdom.EntityRef

This will set the name of this EntityRef.

setNamespace(Namespace). Method in class org.jdom.Attribute

This sets this Attribute's {

setNamespace(Namespace). Method in class org.jdom.Element

This sets this Element's {

setNewlines(boolean). Method in class org.jdom.output.XMLOutputter

Sets whether newlines (lineSeparator) should be printed.

setOmitDeclaration(boolean). Method in class org.jdom.output.XMLOutputter

This will set whether the XML declaration (<?xml version="1.0"?>) will be omitted or not.

setOmitEncoding(boolean). Method in class org.jdom.output.XMLOutputter

This will set whether the XML declaration (<?xml version="1.0" encoding="UTF-8"?>) includes the encoding of the document.

setPadText(boolean). Method in class org.jdom.output.XMLOutputter

Ensure that text immediately preceded by or followed by an element will be "padded" with a single space.

setParent(Element). Method in class org.jdom.Attribute

This will set the parent of this Attribute.

setParent(Element). Method in class org.jdom.CDATA

This will set the parent of the CDATA node to the supplied {

setParent(Element). Method in class org.jdom.Comment

This will set the parent of this Comment.

setParent(Element). Method in class org.jdom.Element

This will set the parent of this Element.

setParent(Element). Method in class org.jdom.EntityRef

This will set the parent of this Entity.

setParent(Element). Method in class org.jdom.ProcessingInstruction

This will set the parent of this ProcessingInstruction.

setParent(Element). Method in class org.jdom.Text

This will set the parent of the Text node to the supplied {

setPIVisible(boolean). Method in class org.jdom.filter.ContentFilter

Set visiblity of ProcessingInstruction objects.

setProperty(String, Object). Method in class org.jdom.input.SAXBuilder

This sets a property on the SAX parser.

setProperty(String, Object). Method in class org.jdom.output.SAXOutputter

This will set the value of a SAX property.

setPublicID(String). Method in class org.jdom.DocType

This will set the public ID of an externally referenced DTD.

setPublicID(String). Method in class org.jdom.EntityRef

This will set the public ID of this EntityRef.

setReportNamespaceDeclarations(boolean). Method in class org.jdom.output.SAXOutputter

This will define whether attribute namespace declarations shall be reported as "xmlns" attributes.

setRootElement(Element). Method in class org.jdom.Document

This sets the root {

setSuppressDeclaration(boolean). Method in class org.jdom.output.XMLOutputter

This will set whether the XML declaration (<?xml version="1.0"?>) will be suppressed or not.

setSystemID(String). Method in class org.jdom.DocType

This will set the system ID of an externally referenced DTD.

setSystemID(String). Method in class org.jdom.EntityRef

This will set the system ID of this EntityRef.

setText(String). Method in class org.jdom.CDATA

This will set the value of this CDATA node.

setText(String). Method in class org.jdom.Comment

This will set the value of the Comment.

setText(String). Method in class org.jdom.Element

This sets the content of the element to be the text given.

setText(String). Method in class org.jdom.Text

This will set the value of this Text node.

setTextNormalize(boolean). Method in class org.jdom.output.XMLOutputter

This will set whether the text is output verbatim (false) or with whitespace normalized as per {

setTextTrim(boolean). Method in class org.jdom.output.XMLOutputter

This will set whether the text has leading/trailing whitespace trimmed.

setTextVisible(boolean). Method in class org.jdom.filter.ContentFilter

Set visiblity of Text objects.

setTrimAllWhite(boolean). Method in class org.jdom.output.XMLOutputter

This will set whether content between tags consisting of all whitespace is printed or trimmed.

setValidation(boolean). Method in class org.jdom.input.DOMBuilder

This sets validation for the builder.

setValidation(boolean). Method in class org.jdom.input.SAXBuilder

This sets validation for the builder.

setValue(String). Method in class org.jdom.Attribute

This will set the value of the Attribute.

setValue(String, String). Method in class org.jdom.ProcessingInstruction

This will set the value for the specified name/value pair.

setXMLFilter(XMLFilter). Method in class org.jdom.input.SAXBuilder

This sets custom XMLFilter for the Builder.

setXMLReader(XMLReader). Method in class org.jdom.transform.JDOMSource
Set the XMLReader to be used for the Source.
skippedEntity(String). Method in class org.jdom.input.SAXHandler

This indicates that an unresolvable entity reference has been encountered, normally because the external DTD subset has not been read.

stack. Variable in class org.jdom.input.SAXHandler
Element stack
startCDATA(). Method in class org.jdom.input.SAXHandler

Report a CDATA section - ignored in SAXBuilder.

startDTD(String, String, String). Method in class org.jdom.input.SAXHandler

This will signify that a DTD is being parsed, and can be used to ensure that comments and other lexical structures in the DTD are not added to the JDOM Document object.

startElement(String, String, String, Attributes). Method in class org.jdom.input.SAXHandler

This reports the occurrence of an actual element.

startEntity(String). Method in class org.jdom.input.SAXHandler
startPrefixMapping(String, String). Method in class org.jdom.input.SAXHandler

This will add the prefix mapping to the JDOM Document object.

suppress. Variable in class org.jdom.input.SAXHandler
Indicator of whether we are actively suppressing (non-expanding) a current entity
systemID. Variable in class org.jdom.DocType
The system ID of the DOCTYPE
systemID. Variable in class org.jdom.EntityRef
The SystemID of the EntityRef

T

target. Variable in class org.jdom.ProcessingInstruction
The target of the PI
text. Variable in class org.jdom.Comment
Text of the Comment
TEXT. Static variable in class org.jdom.filter.ContentFilter
Mask for JDOM Text objects
Text(). Constructor for class org.jdom.Text

This is the protected, no-args constructor standard in all JDOM classes.

text(String). Method in class org.jdom.input.DefaultJDOMFactory
text(String). Method in interface org.jdom.input.JDOMFactory

This creates the Text with the supplied text.

Text(String). Constructor for class org.jdom.Text

This constructor creates a new Text node, with the supplied string value as it's character content.

toString(). Method in class org.jdom.Attribute

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

toString(). Method in class org.jdom.CDATA

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

toString(). Method in class org.jdom.Comment

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

toString(). Method in class org.jdom.DocType

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

toString(). Method in class org.jdom.Document

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

toString(). Method in class org.jdom.Element

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

toString(). Method in class org.jdom.EntityRef

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

toString(). Method in class org.jdom.Namespace

This returns a String representation of this Namespace, suitable for use in debugging.

toString(). Method in class org.jdom.ProcessingInstruction

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

toString(). Method in class org.jdom.Text

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

toString(). Method in class org.jdom.output.XMLOutputter

Return a string listing of the settings for this XMLOutputter instance.

type. Variable in class org.jdom.Attribute
The type of the Attribute

U

UNDECLARED_ATTRIBUTE. Static variable in class org.jdom.Attribute

Attribute type: the attribute has not been declared or type is unknown.

unparsedEntityDecl(String, String, String, String). Method in class org.jdom.input.SAXHandler

Handler for unparsed entity declarations in the DTD


V

value. Variable in class org.jdom.Attribute
The value of the Attribute
value. Variable in class org.jdom.CDATA
The actual character content
value. Variable in class org.jdom.Text
The actual character content

W

warning(SAXParseException). Method in class org.jdom.input.BuilderErrorHandler

This method is called when a warning has occurred; this indicates that while no XML rules were broken, something appears to be incorrect or missing.


X

XercesDOMAdapter(). Constructor for class org.jdom.adapters.XercesDOMAdapter
XML4JDOMAdapter(). Constructor for class org.jdom.adapters.XML4JDOMAdapter
XML_NAMESPACE. Static variable in class org.jdom.Namespace
XMLOutputter(). Constructor for class org.jdom.output.XMLOutputter

This will create an XMLOutputter with no additional whitespace (indent or newlines) added; the whitespace from the element text content is fully preserved.

XMLOutputter(String). Constructor for class org.jdom.output.XMLOutputter

This will create an XMLOutputter with the given indent added but no new lines added; all whitespace from the element text content is included as well.

XMLOutputter(String, boolean). Constructor for class org.jdom.output.XMLOutputter

This will create an XMLOutputter with the given indent that prints newlines only if newlines is true; all whitespace from the element text content is included as well.

XMLOutputter(String, boolean, String). Constructor for class org.jdom.output.XMLOutputter

This will create an XMLOutputter with the given indent and new lines printing only if newlines is true, and encoding format encoding.

XMLOutputter(XMLOutputter). Constructor for class org.jdom.output.XMLOutputter

This will create an XMLOutputter with all the options as set in the given XMLOutputter.