| Package | Description |
|---|---|
| org.jdom2 |
Classes representing the components of an XML document.
|
| org.jdom2.filter |
Classes to both filter and generically type-cast nodes of a document
based on type, name, value, or other aspects, and to boolean
AND/OR/NEGATE these rules.
|
| org.jdom2.input |
Classes to build JDOM documents from various sources.
|
| org.jdom2.input.sax |
Support classes for building JDOM documents and content using SAX parsers.
|
| org.jdom2.output |
Classes to output JDOM documents to various destinations.
|
| org.jdom2.output.support |
Classes used to implement output functionality that are not part of the
actual Output API, but rather part of the implementation.
|
| org.jdom2.transform |
Classes to help with transformations, based on the JAXP TrAX classes.
|
| Modifier and Type | Method | Description |
|---|---|---|
Document |
Document.addContent(int index,
java.util.Collection<? extends Content> c) |
Inserts the content in a collection into the content list
at the given index.
|
Document |
Document.addContent(int index,
Content child) |
Inserts the child into the content list at the given index.
|
Document |
Document.addContent(java.util.Collection<? extends Content> c) |
Appends all children in the given collection to the end of
the content list.
|
Document |
Document.addContent(Content child) |
Appends the child to the end of the content list.
|
Document |
Document.clone() |
This will return a deep clone of this
Document. |
Document |
DefaultJDOMFactory.document(Element rootElement) |
|
Document |
DefaultJDOMFactory.document(Element rootElement,
DocType docType) |
|
Document |
DefaultJDOMFactory.document(Element rootElement,
DocType docType,
java.lang.String baseURI) |
|
Document |
JDOMFactory.document(Element rootElement) |
|
Document |
JDOMFactory.document(Element rootElement,
DocType docType) |
|
Document |
JDOMFactory.document(Element rootElement,
DocType docType,
java.lang.String baseURI) |
|
Document |
UncheckedJDOMFactory.document(Element rootElement) |
|
Document |
UncheckedJDOMFactory.document(Element rootElement,
DocType docType) |
|
Document |
UncheckedJDOMFactory.document(Element rootElement,
DocType docType,
java.lang.String baseURI) |
|
Document |
Attribute.getDocument() |
Get this Attribute's Document.
|
Document |
Content.getDocument() |
Return this child's owning document or null if the branch containing
this child is currently not attached to a document.
|
Document |
Document.getDocument() |
Always returns this Document Instance
|
Document |
Parent.getDocument() |
Return this parent's owning document or null if the branch containing
this parent is currently not attached to a document.
|
Document |
DocType.getParent() |
|
Document |
Document.setContent(int index,
java.util.Collection<? extends Content> collection) |
Replace the child at the given index whith the supplied
collection.
|
Document |
Document.setContent(int index,
Content child) |
Replace the current child the given index with the supplied child.
|
Document |
Document.setContent(java.util.Collection<? extends Content> newContent) |
This sets the content of the
Document. |
Document |
Document.setContent(Content child) |
Set this document's content to be the supplied child.
|
Document |
Document.setDocType(DocType docType) |
This will set the
declaration for this Document. |
Document |
Document.setRootElement(Element rootElement) |
This sets the root
for the
Document. |
| Modifier and Type | Method | Description |
|---|---|---|
void |
DefaultJDOMFactory.setRoot(Document doc,
Element root) |
|
void |
JDOMFactory.setRoot(Document doc,
Element root) |
Sets the 'root' Element for a Document.
|
void |
UncheckedJDOMFactory.setRoot(Document doc,
Element root) |
| Modifier and Type | Method | Description |
|---|---|---|
static Filter<Document> |
Filters.document() |
Return a Filter that matches any
Document data. |
| Modifier and Type | Method | Description |
|---|---|---|
Document |
DOMBuilder.build(org.w3c.dom.Document domDocument) |
This will build a JDOM tree from an existing DOM tree.
|
Document |
SAXBuilder.build(java.io.File file) |
This builds a document from the supplied filename.
|
Document |
SAXBuilder.build(java.io.InputStream in) |
This builds a document from the supplied input stream.
|
Document |
SAXBuilder.build(java.io.InputStream in,
java.lang.String systemId) |
This builds a document from the supplied input stream.
|
Document |
SAXBuilder.build(java.io.Reader characterStream) |
This builds a document from the supplied Reader.
|
Document |
SAXBuilder.build(java.io.Reader characterStream,
java.lang.String systemId) |
This builds a document from the supplied Reader.
|
Document |
SAXBuilder.build(java.lang.String systemId) |
This builds a document from the supplied URI.
|
Document |
SAXBuilder.build(java.net.URL url) |
This builds a document from the supplied URL.
|
Document |
SAXBuilder.build(org.xml.sax.InputSource in) |
This builds a document from the supplied input source.
|
Document |
StAXEventBuilder.build(javax.xml.stream.XMLEventReader events) |
This builds a document from the supplied
XMLEventReader.
|
Document |
StAXStreamBuilder.build(javax.xml.stream.XMLStreamReader reader) |
This builds a document from the supplied
XMLStreamReader.
|
Document |
JDOMParseException.getPartialDocument() |
Returns the partial document that was successfully built before
the error occurred.
|
| Constructor | Description |
|---|---|
JDOMParseException(java.lang.String message,
java.lang.Throwable cause,
Document partialDocument) |
This will create a parse
Exception with the given
message and the partial document and wrap the
Exception that cause a document parse to fail. |
| Modifier and Type | Method | Description |
|---|---|---|
Document |
SAXBuilderEngine.build(java.io.File file) |
|
Document |
SAXBuilderEngine.build(java.io.InputStream in) |
|
Document |
SAXBuilderEngine.build(java.io.InputStream in,
java.lang.String systemId) |
|
Document |
SAXBuilderEngine.build(java.io.Reader characterStream) |
|
Document |
SAXBuilderEngine.build(java.io.Reader characterStream,
java.lang.String systemId) |
|
Document |
SAXBuilderEngine.build(java.lang.String systemId) |
|
Document |
SAXBuilderEngine.build(java.net.URL url) |
|
Document |
SAXBuilderEngine.build(org.xml.sax.InputSource in) |
|
Document |
SAXEngine.build(java.io.File file) |
This builds a document from the supplied filename.
|
Document |
SAXEngine.build(java.io.InputStream in) |
This builds a document from the supplied input stream.
|
Document |
SAXEngine.build(java.io.InputStream in,
java.lang.String systemId) |
This builds a document from the supplied input stream.
|
Document |
SAXEngine.build(java.io.Reader characterStream) |
This builds a document from the supplied Reader.
|
Document |
SAXEngine.build(java.io.Reader characterStream,
java.lang.String systemId) |
This builds a document from the supplied Reader.
|
Document |
SAXEngine.build(java.lang.String systemId) |
This builds a document from the supplied URI.
|
Document |
SAXEngine.build(java.net.URL url) |
This builds a document from the supplied URL.
|
Document |
SAXEngine.build(org.xml.sax.InputSource in) |
This builds a document from the supplied input source.
|
Document |
SAXHandler.getDocument() |
Returns the document.
|
| Modifier and Type | Method | Description |
|---|---|---|
org.w3c.dom.Document |
DOMOutputter.output(Document document) |
This converts the JDOM
Document parameter to a DOM Document,
returning the DOM version. |
void |
SAXOutputter.output(Document document) |
This will output the
JDOM Document, firing off the SAX
events that have been registered. |
void |
StAXEventOutputter.output(Document doc,
javax.xml.stream.util.XMLEventConsumer out) |
This will print the
Document to the given Writer. |
void |
StAXStreamOutputter.output(Document doc,
javax.xml.stream.XMLStreamWriter out) |
This will print the
Document to the given Writer. |
void |
XMLOutputter.output(Document doc,
java.io.OutputStream out) |
This will print the
to the given
OutputStream. |
void |
XMLOutputter.output(Document doc,
java.io.Writer out) |
This will print the
Document to the given Writer. |
java.lang.String |
XMLOutputter.outputString(Document doc) |
Return a string representing a
Document. |
| Modifier and Type | Method | Description |
|---|---|---|
protected org.w3c.dom.Document |
AbstractDOMOutputProcessor.printDocument(FormatStack fstack,
NamespaceStack nstack,
org.w3c.dom.Document basedoc,
Document doc) |
This will handle printing of a
Document. |
protected void |
AbstractSAXOutputProcessor.printDocument(SAXTarget out,
FormatStack fstack,
NamespaceStack nstack,
Document document) |
This will handle printing of a
Document. |
protected void |
AbstractStAXEventProcessor.printDocument(javax.xml.stream.util.XMLEventConsumer out,
FormatStack fstack,
NamespaceStack nstack,
javax.xml.stream.XMLEventFactory eventfactory,
Document doc) |
This will handle printing of a
Document. |
protected void |
AbstractStAXStreamProcessor.printDocument(javax.xml.stream.XMLStreamWriter out,
FormatStack fstack,
NamespaceStack nstack,
Document doc) |
This will handle printing of a
Document. |
protected void |
AbstractXMLOutputProcessor.printDocument(java.io.Writer out,
FormatStack fstack,
NamespaceStack nstack,
Document doc) |
This will handle printing of a
Document. |
org.w3c.dom.Document |
AbstractDOMOutputProcessor.process(org.w3c.dom.Document basedoc,
Format format,
Document doc) |
|
void |
AbstractSAXOutputProcessor.process(SAXTarget out,
Format format,
Document doc) |
|
void |
AbstractStAXEventProcessor.process(javax.xml.stream.util.XMLEventConsumer out,
Format format,
javax.xml.stream.XMLEventFactory eventfactory,
Document doc) |
|
void |
AbstractStAXStreamProcessor.process(javax.xml.stream.XMLStreamWriter out,
Format format,
Document doc) |
|
void |
AbstractXMLOutputProcessor.process(java.io.Writer out,
Format format,
Document doc) |
|
org.w3c.dom.Document |
DOMOutputProcessor.process(org.w3c.dom.Document basedoc,
Format format,
Document doc) |
This will convert the
to the given DOM
Document. |
void |
SAXOutputProcessor.process(SAXTarget out,
Format format,
Document doc) |
This will print the
to the given SAXTarget. |
void |
StAXEventProcessor.process(javax.xml.stream.util.XMLEventConsumer out,
Format format,
javax.xml.stream.XMLEventFactory eventfactory,
Document doc) |
This will print the
to the given XMLEventConsumer. |
void |
StAXStreamProcessor.process(javax.xml.stream.XMLStreamWriter out,
Format format,
Document doc) |
This will print the
to the given XMLStreamWriter. |
void |
XMLOutputProcessor.process(java.io.Writer out,
Format format,
Document doc) |
This will print the
to the given Writer. |
| Modifier and Type | Method | Description |
|---|---|---|
Document |
JDOMResult.getDocument() |
Returns the result of an XSL Transformation as a JDOM document.
|
Document |
JDOMSource.getDocument() |
Returns the source document used by this TrAX source.
|
Document |
XSLTransformer.transform(Document inputDoc) |
Transforms the given document to an output document.
|
Document |
XSLTransformer.transform(Document inputDoc,
org.xml.sax.EntityResolver resolver) |
Transforms the given document to an output document.
|
| Modifier and Type | Method | Description |
|---|---|---|
void |
JDOMResult.setDocument(Document document) |
Sets the document produced as result of an XSL Transformation.
|
void |
JDOMSource.setDocument(Document source) |
Sets the source document used by this TrAX source.
|
Document |
XSLTransformer.transform(Document inputDoc) |
Transforms the given document to an output document.
|
Document |
XSLTransformer.transform(Document inputDoc,
org.xml.sax.EntityResolver resolver) |
Transforms the given document to an output document.
|
| Constructor | Description |
|---|---|
JDOMSource(Document source) |
Creates a JDOM TrAX source wrapping a JDOM document.
|
JDOMSource(Document source,
org.xml.sax.EntityResolver resolver) |
Creates a JDOM TrAX source wrapping a JDOM element with an
associated EntityResolver to resolve external entities.
|
XSLTransformer(Document stylesheet) |
This will create a new
XSLTransformer by
reading the stylesheet from the specified
Document. |
Copyright ? 2019 Jason Hunter, Brett McLaughlin. All Rights Reserved.