org.jdom2
Interface JDOMFactory

All Known Implementing Classes:

DefaultJDOMFactory, LocatedJDOMFactory, SlimJDOMFactory, UncheckedJDOMFactory

public interface JDOMFactory

An interface to be used by builders when constructing JDOM objects. The DefaultJDOMFactory creates the standard top-level JDOM classes (Element, Document, Comment, etc). Another implementation of this factory could be used to create custom classes.

Author:

Ken Rune Holland, Phil Nelson, Bradley S. Huffman, Rolf Lear

Method Summary

void	addContent(Parent parent, Content content) This will add the specified content to the specified parent instance
void	addNamespaceDeclaration(Element element, Namespace additional) Adds a namespace declaration to an Element
Attribute	attribute(java.lang.String name, java.lang.String value) This will create a new Attribute with the specified (local) name and value, and does not place the attribute in a Namespace.
Attribute	attribute(java.lang.String name, java.lang.String value, AttributeType type) This will create a new Attribute with the specified (local) name, value and type, and does not place the attribute in a Namespace.
Attribute	attribute(java.lang.String name, java.lang.String value, AttributeType type, Namespace namespace) This will create a new Attribute with the specified (local) name, value, and type, and in the provided Namespace.
Attribute	attribute(java.lang.String name, java.lang.String value, int type) Deprecated. use attribute(String, String, AttributeType)
Attribute	attribute(java.lang.String name, java.lang.String value, int type, Namespace namespace) Deprecated. Use attribute(String, String, AttributeType, Namespace)
Attribute	attribute(java.lang.String name, java.lang.String value, Namespace namespace) This will create a new Attribute with the specified (local) name and value, and in the provided Namespace.
CDATA	cdata(int line, int col, java.lang.String str) This creates the CDATA with the supplied text.
CDATA	cdata(java.lang.String str) This creates the CDATA with the supplied text.
Comment	comment(int line, int col, java.lang.String text) This creates the comment with the supplied text.
Comment	comment(java.lang.String text) This creates the comment with the supplied text.
DocType	docType(int line, int col, java.lang.String elementName) This will create the DocType with the specified element name
DocType	docType(int line, int col, java.lang.String elementName, java.lang.String systemID) This will create the DocType with the specified element name and reference to an external DTD.
DocType	docType(int line, int col, java.lang.String elementName, java.lang.String publicID, java.lang.String systemID) This will create the DocType with the specified element name and a reference to an external DTD.
DocType	docType(java.lang.String elementName) This will create the DocType with the specified element name
DocType	docType(java.lang.String elementName, java.lang.String systemID) This will create the DocType with the specified element name and reference to an external DTD.
DocType	docType(java.lang.String elementName, java.lang.String publicID, java.lang.String systemID) This will create the DocType with the specified element name and a reference to an external DTD.
Document	document(Element rootElement) This will create a new Document, with the supplied Element as the root element, and no DocType declaration.
Document	document(Element rootElement, DocType docType) This will create a new Document, with the supplied Element as the root element and the supplied DocType declaration.
Document	document(Element rootElement, DocType docType, java.lang.String baseURI) This will create a new Document, with the supplied Element as the root element and the supplied DocType declaration.
Element	element(int line, int col, java.lang.String name) This will create an Element in no Namespace.
Element	element(int line, int col, java.lang.String name, Namespace namespace) This will create a new Element with the supplied (local) name, and define the Namespace to be used.
Element	element(int line, int col, java.lang.String name, java.lang.String uri) This will create a new Element with the supplied (local) name, and specifies the URI of the Namespace the Element should be in, resulting it being unprefixed (in the default namespace).
Element	element(int line, int col, java.lang.String name, java.lang.String prefix, java.lang.String uri) This will create a new Element with the supplied (local) name, and specifies the prefix and URI of the Namespace the Element should be in.
Element	element(java.lang.String name) This will create an Element in no Namespace.
Element	element(java.lang.String name, Namespace namespace) This will create a new Element with the supplied (local) name, and define the Namespace to be used.
Element	element(java.lang.String name, java.lang.String uri) This will create a new Element with the supplied (local) name, and specifies the URI of the Namespace the Element should be in, resulting it being unprefixed (in the default namespace).
Element	element(java.lang.String name, java.lang.String prefix, java.lang.String uri) This will create a new Element with the supplied (local) name, and specifies the prefix and URI of the Namespace the Element should be in.
EntityRef	entityRef(int line, int col, java.lang.String name) This will create a new EntityRef with the supplied name.
EntityRef	entityRef(int line, int col, java.lang.String name, java.lang.String systemID) This will create a new EntityRef with the supplied name and system ID.
EntityRef	entityRef(int line, int col, java.lang.String name, java.lang.String publicID, java.lang.String systemID) This will create a new EntityRef with the supplied name, public ID, and system ID.
EntityRef	entityRef(java.lang.String name) This will create a new EntityRef with the supplied name.
EntityRef	entityRef(java.lang.String name, java.lang.String systemID) This will create a new EntityRef with the supplied name and system ID.
EntityRef	entityRef(java.lang.String name, java.lang.String publicID, java.lang.String systemID) This will create a new EntityRef with the supplied name, public ID, and system ID.
ProcessingInstruction	processingInstruction(int line, int col, java.lang.String target) This will create a new ProcessingInstruction with the specified target and no data.
ProcessingInstruction	processingInstruction(int line, int col, java.lang.String target, java.util.Map<java.lang.String,java.lang.String> data) This will create a new ProcessingInstruction with the specified target and data.
ProcessingInstruction	processingInstruction(int line, int col, java.lang.String target, java.lang.String data) This will create a new ProcessingInstruction with the specified target and data.
ProcessingInstruction	processingInstruction(java.lang.String target) This will create a new ProcessingInstruction with the specified target and no data.
ProcessingInstruction	processingInstruction(java.lang.String target, java.util.Map<java.lang.String,java.lang.String> data) This will create a new ProcessingInstruction with the specified target and data.
ProcessingInstruction	processingInstruction(java.lang.String target, java.lang.String data) This will create a new ProcessingInstruction with the specified target and data.
void	setAttribute(Element element, Attribute a) Sets a specific Attribute on an Element
void	setRoot(Document doc, Element root) Sets the 'root' Element for a Document.
Text	text(int line, int col, java.lang.String str) This creates the Text with the supplied text.
Text	text(java.lang.String str) This creates the Text with the supplied text.

Method Detail

attribute

Attribute attribute(java.lang.String name,
                    java.lang.String value,
                    Namespace namespace)

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

Parameters:

name - String name of Attribute.

value - String value for new attribute.

namespace - Namespace of the new Attribute

Returns:

the created Attribute instance

attribute

@Deprecated
Attribute attribute(java.lang.String name,
                               java.lang.String value,
                               int type,
                               Namespace namespace)

Deprecated. Use attribute(String, String, AttributeType, Namespace)

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

Parameters:

name - String name of Attribute.

value - String value for new attribute.

type - int type for new attribute.

namespace - Namespace namespace for new attribute.

Returns:

the created Attribute instance

attribute

Attribute attribute(java.lang.String name,
                    java.lang.String value,
                    AttributeType type,
                    Namespace namespace)

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

Parameters:

name - String name of Attribute.

value - String value for new attribute.

type - AttributeType type for new attribute.

namespace - Namespace namespace for new attribute.

Returns:

the created Attribute instance

attribute

Attribute attribute(java.lang.String name,
                    java.lang.String value)

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

Note: This actually explicitly puts the Attribute in the "empty" Namespace (Namespace.NO_NAMESPACE).

Parameters:

name - String name of Attribute.

value - String value for new attribute.

Returns:

the created Attribute instance

attribute

@Deprecated
Attribute attribute(java.lang.String name,
                               java.lang.String value,
                               int type)

Deprecated. use attribute(String, String, AttributeType)

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

Note: This actually explicitly puts the Attribute in the "empty" Namespace (Namespace.NO_NAMESPACE).

Parameters:

name - String name of Attribute.

value - String value for new attribute.

type - int type for new attribute.

Returns:

the created Attribute instance

attribute

Attribute attribute(java.lang.String name,
                    java.lang.String value,
                    AttributeType type)

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

Note: This actually explicitly puts the Attribute in the "empty" Namespace (Namespace.NO_NAMESPACE).

Parameters:

name - String name of Attribute.

value - String value for new attribute.

type - AttributeType type for new attribute.

Returns:

the created Attribute instance

cdata

CDATA cdata(java.lang.String str)

This creates the CDATA with the supplied text.

Parameters:

str - String content of CDATA.

Returns:

the created CDATA instance

cdata

CDATA cdata(int line,
            int col,
            java.lang.String str)

This creates the CDATA with the supplied text.

Parameters:

line - The line on which this content begins.

col - The column on the line at which this content begins.

str - String content of CDATA.

Returns:

the created CDATA instance

Since:

JDOM2

text

Text text(int line,
          int col,
          java.lang.String str)

This creates the Text with the supplied text.

Parameters:

line - The line on which this content begins.

col - The column on the line at which this content begins.

str - String content of Text.

Returns:

the created Text instance

Since:

JDOM2

text

Text text(java.lang.String str)

This creates the Text with the supplied text.

Parameters:

str - String content of Text.

Returns:

the created Text instance

comment

Comment comment(java.lang.String text)

This creates the comment with the supplied text.

Parameters:

text - String content of comment.

Returns:

the created Comment instance

comment

Comment comment(int line,
                int col,
                java.lang.String text)

This creates the comment with the supplied text.

Parameters:

line - The line on which this content begins.

col - The column on the line at which this content begins.

text - String content of comment.

Returns:

the created Comment instance

Since:

JDOM2

docType

DocType docType(java.lang.String elementName,
                java.lang.String publicID,
                java.lang.String systemID)

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

Parameters:

elementName - String name of element being constrained.

publicID - String public ID of referenced DTD

systemID - String system ID of referenced DTD

Returns:

the created DocType instance

docType

DocType docType(java.lang.String elementName,
                java.lang.String systemID)

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

Parameters:

elementName - String name of element being constrained.

systemID - String system ID of referenced DTD

Returns:

the created DocType instance

docType

DocType docType(java.lang.String elementName)

This will create the DocType with the specified element name

Parameters:

elementName - String name of element being constrained.

Returns:

the created DocType instance

docType

DocType docType(int line,
                int col,
                java.lang.String elementName,
                java.lang.String publicID,
                java.lang.String systemID)

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

Parameters:

line - The line on which this content begins.

col - The column on the line at which this content begins.

elementName - String name of element being constrained.

publicID - String public ID of referenced DTD

systemID - String system ID of referenced DTD

Returns:

the created DocType instance

Since:

JDOM2

docType

DocType docType(int line,
                int col,
                java.lang.String elementName,
                java.lang.String systemID)

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

Parameters:

line - The line on which this content begins.

col - The column on the line at which this content begins.

elementName - String name of element being constrained.

systemID - String system ID of referenced DTD

Returns:

the created DocType instance

Since:

JDOM2

docType

DocType docType(int line,
                int col,
                java.lang.String elementName)

This will create the DocType with the specified element name

Parameters:

line - The line on which this content begins.

col - The column on the line at which this content begins.

elementName - String name of element being constrained.

Returns:

the created DocType instance

Since:

JDOM2

document

Document document(Element rootElement,
                  DocType docType)

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

Parameters:

rootElement - Element for document root.

docType - DocType declaration.

Returns:

the created Document instance

document

Document document(Element rootElement,
                  DocType docType,
                  java.lang.String baseURI)

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

Parameters:

rootElement - Element for document root.

docType - DocType declaration.

baseURI - the URI from which this doucment was loaded.

Returns:

the created Document instance

document

Document document(Element rootElement)

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

Parameters:

rootElement - Element for document root

Returns:

the created Document instance

element

Element element(java.lang.String name,
                Namespace namespace)

This will create a new Element with the supplied (local) name, and define the Namespace to be used.

Parameters:

name - String name of element.

namespace - Namespace to put element in.

Returns:

the created Element instance

element

Element element(java.lang.String name)

This will create an Element in no Namespace.

Parameters:

name - String name of element.

Returns:

the created Element instance

element

Element element(java.lang.String name,
                java.lang.String uri)

This will create a new Element with the supplied (local) name, and specifies the URI of the Namespace the Element should be in, resulting it being unprefixed (in the default namespace).

Parameters:

name - String name of element.

uri - String URI for Namespace element should be in.

Returns:

the created Element instance

element

Element element(java.lang.String name,
                java.lang.String prefix,
                java.lang.String uri)

This will create a new Element with the supplied (local) name, and specifies the prefix and URI of the Namespace the Element should be in.

Parameters:

name - String name of element.

prefix - the NamespacePrefic to use for this Element

uri - String URI for Namespace element should be in.

Returns:

the created Element instance

element

Element element(int line,
                int col,
                java.lang.String name,
                Namespace namespace)

This will create a new Element with the supplied (local) name, and define the Namespace to be used.

Parameters:

line - The line on which this content begins.

col - The column on the line at which this content begins.

name - String name of element.

namespace - Namespace to put element in.

Returns:

the created Element instance

Since:

JDOM2

element

Element element(int line,
                int col,
                java.lang.String name)

This will create an Element in no Namespace.

Parameters:

line - The line on which this content begins.

col - The column on the line at which this content begins.

name - String name of element.

Returns:

the created Element instance

Since:

JDOM2

element

Element element(int line,
                int col,
                java.lang.String name,
                java.lang.String uri)

This will create a new Element with the supplied (local) name, and specifies the URI of the Namespace the Element should be in, resulting it being unprefixed (in the default namespace).

Parameters:

line - The line on which this content begins.

col - The column on the line at which this content begins.

name - String name of element.

uri - String URI for Namespace element should be in.

Returns:

the created Element instance

Since:

JDOM2

element

Element element(int line,
                int col,
                java.lang.String name,
                java.lang.String prefix,
                java.lang.String uri)

This will create a new Element with the supplied (local) name, and specifies the prefix and URI of the Namespace the Element should be in.

Parameters:

line - The line on which this content begins.

col - The column on the line at which this content begins.

name - String name of element.

prefix - the NamespacePrefic to use for this Element

uri - String URI for Namespace element should be in.

Returns:

the created Element instance

Since:

JDOM2

processingInstruction

ProcessingInstruction processingInstruction(java.lang.String target,
                                            java.util.Map<java.lang.String,java.lang.String> data)

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

Parameters:

target - String target of PI.

data - Map data for PI, in name/value pairs

Returns:

the created ProcessingInstruction instance

processingInstruction

ProcessingInstruction processingInstruction(java.lang.String target,
                                            java.lang.String data)

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

Parameters:

target - String target of PI.

data - String data for PI.

Returns:

the created ProcessingInstruction instance

processingInstruction

ProcessingInstruction processingInstruction(java.lang.String target)

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

Parameters:

target - String target of PI.

Returns:

the created ProcessingInstruction instance

processingInstruction

ProcessingInstruction processingInstruction(int line,
                                            int col,
                                            java.lang.String target,
                                            java.util.Map<java.lang.String,java.lang.String> data)

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

Parameters:

line - The line on which this content begins.

col - The column on the line at which this content begins.

target - String target of PI.

data - Map data for PI, in name/value pairs

Returns:

the created ProcessingInstruction instance

Since:

JDOM2

processingInstruction

ProcessingInstruction processingInstruction(int line,
                                            int col,
                                            java.lang.String target,
                                            java.lang.String data)

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

Parameters:

line - The line on which this content begins.

col - The column on the line at which this content begins.

target - String target of PI.

data - String data for PI.

Returns:

the created ProcessingInstruction instance

Since:

JDOM2

processingInstruction

ProcessingInstruction processingInstruction(int line,
                                            int col,
                                            java.lang.String target)

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

Parameters:

line - The line on which this content begins.

col - The column on the line at which this content begins.

target - String target of PI.

Returns:

the created ProcessingInstruction instance

Since:

JDOM2

entityRef

EntityRef entityRef(java.lang.String name)

This will create a new EntityRef with the supplied name.

Parameters:

name - String name of element.

Returns:

the created EntityRef instance

entityRef

EntityRef entityRef(java.lang.String name,
                    java.lang.String publicID,
                    java.lang.String systemID)

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

Parameters:

name - String name of element.

publicID - String public ID of element.

systemID - String system ID of element.

Returns:

the created EntityRef instance

entityRef

EntityRef entityRef(java.lang.String name,
                    java.lang.String systemID)

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

Parameters:

name - String name of element.

systemID - String system ID of element.

Returns:

the created EntityRef instance

entityRef

EntityRef entityRef(int line,
                    int col,
                    java.lang.String name)

This will create a new EntityRef with the supplied name.

Parameters:

line - The line on which this content begins.

col - The column on the line at which this content begins.

name - String name of element.

Returns:

the created EntityRef instance

Since:

JDOM2

entityRef

EntityRef entityRef(int line,
                    int col,
                    java.lang.String name,
                    java.lang.String publicID,
                    java.lang.String systemID)

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

Parameters:

line - The line on which this content begins.

col - The column on the line at which this content begins.

name - String name of element.

publicID - String public ID of element.

systemID - String system ID of element.

Returns:

the created EntityRef instance

Since:

JDOM2

entityRef

EntityRef entityRef(int line,
                    int col,
                    java.lang.String name,
                    java.lang.String systemID)

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

Parameters:

line - The line on which this content begins.

col - The column on the line at which this content begins.

name - String name of element.

systemID - String system ID of element.

Returns:

the created EntityRef instance

Since:

JDOM2

addContent

void addContent(Parent parent,
                Content content)

This will add the specified content to the specified parent instance

Parameters:

parent - The Parent to add the content to.

content - The Content to add

setAttribute

void setAttribute(Element element,
                  Attribute a)

Sets a specific Attribute on an Element

Parameters:

element - The Element to set the Attribute on

a - The Attribute to set

addNamespaceDeclaration

void addNamespaceDeclaration(Element element,
                             Namespace additional)

Adds a namespace declaration to an Element

Parameters:

element - The Element to add the Namespace to

additional - The Namespace to add.

setRoot

void setRoot(Document doc,
             Element root)

Sets the 'root' Element for a Document.

Parameters:

doc - The Document to set the Root Element of.

root - The Element to set as the root.