org.jdom2
Class DefaultJDOMFactory

java.lang.Object
  org.jdom2.DefaultJDOMFactory

All Implemented Interfaces:

JDOMFactory

Direct Known Subclasses:

LocatedJDOMFactory, SlimJDOMFactory, UncheckedJDOMFactory

public class DefaultJDOMFactory
extends java.lang.Object
implements JDOMFactory

Creates the standard top-level JDOM classes (Element, Document, Comment, etc). A subclass of this factory might construct custom classes.

Author:

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

Constructor Summary

DefaultJDOMFactory()
Creates a new DefaultJDOMFactory instance.

Method Summary

void	addContent(Parent parent, Content child) This will add the specified content to the specified parent instance
void	addNamespaceDeclaration(Element parent, 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.
Attribute	attribute(java.lang.String name, java.lang.String value, int type, Namespace namespace) Deprecated.
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 text) 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 parent, 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 text) This creates the Text with the supplied text.
Text	text(java.lang.String str) This creates the Text with the supplied text.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultJDOMFactory

public DefaultJDOMFactory()

Creates a new DefaultJDOMFactory instance.

Method Detail

attribute

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

Description copied from interface: JDOMFactory

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

Specified by:

attribute in interface JDOMFactory

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
public Attribute attribute(java.lang.String name,
                                      java.lang.String value,
                                      int type,
                                      Namespace namespace)

Deprecated.

Description copied from interface: JDOMFactory

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

Specified by:

attribute in interface JDOMFactory

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

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

Description copied from interface: JDOMFactory

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

Specified by:

attribute in interface JDOMFactory

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

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

Description copied from interface: JDOMFactory

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).

Specified by:

attribute in interface JDOMFactory

Parameters:

name - String name of Attribute.

value - String value for new attribute.

Returns:

the created Attribute instance

attribute

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

Deprecated.

Description copied from interface: JDOMFactory

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).

Specified by:

attribute in interface JDOMFactory

Parameters:

name - String name of Attribute.

value - String value for new attribute.

type - int type for new attribute.

Returns:

the created Attribute instance

attribute

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

Description copied from interface: JDOMFactory

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).

Specified by:

attribute in interface JDOMFactory

Parameters:

name - String name of Attribute.

value - String value for new attribute.

type - AttributeType type for new attribute.

Returns:

the created Attribute instance

cdata

public final CDATA cdata(java.lang.String str)

Description copied from interface: JDOMFactory

This creates the CDATA with the supplied text.

Specified by:

cdata in interface JDOMFactory

Parameters:

str - String content of CDATA.

Returns:

the created CDATA instance

cdata

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

Description copied from interface: JDOMFactory

This creates the CDATA with the supplied text.

Specified by:

cdata in interface JDOMFactory

Parameters:

line - The line on which this content begins.

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

text - String content of CDATA.

Returns:

the created CDATA instance

text

public final Text text(java.lang.String str)

Description copied from interface: JDOMFactory

This creates the Text with the supplied text.

Specified by:

text in interface JDOMFactory

Parameters:

str - String content of Text.

Returns:

the created Text instance

text

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

Description copied from interface: JDOMFactory

This creates the Text with the supplied text.

Specified by:

text in interface JDOMFactory

Parameters:

line - The line on which this content begins.

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

text - String content of Text.

Returns:

the created Text instance

comment

public final Comment comment(java.lang.String text)

Description copied from interface: JDOMFactory

This creates the comment with the supplied text.

Specified by:

comment in interface JDOMFactory

Parameters:

text - String content of comment.

Returns:

the created Comment instance

comment

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

Description copied from interface: JDOMFactory

This creates the comment with the supplied text.

Specified by:

comment in interface JDOMFactory

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

docType

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

Description copied from interface: JDOMFactory

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

Specified by:

docType in interface JDOMFactory

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

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

Description copied from interface: JDOMFactory

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

Specified by:

docType in interface JDOMFactory

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

docType

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

Description copied from interface: JDOMFactory

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

Specified by:

docType in interface JDOMFactory

Parameters:

elementName - String name of element being constrained.

systemID - String system ID of referenced DTD

Returns:

the created DocType instance

docType

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

Description copied from interface: JDOMFactory

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

Specified by:

docType in interface JDOMFactory

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

docType

public final DocType docType(java.lang.String elementName)

Description copied from interface: JDOMFactory

This will create the DocType with the specified element name

Specified by:

docType in interface JDOMFactory

Parameters:

elementName - String name of element being constrained.

Returns:

the created DocType instance

docType

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

Description copied from interface: JDOMFactory

This will create the DocType with the specified element name

Specified by:

docType in interface JDOMFactory

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

document

public Document document(Element rootElement,
                         DocType docType)

Description copied from interface: JDOMFactory

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

Specified by:

document in interface JDOMFactory

Parameters:

rootElement - Element for document root.

docType - DocType declaration.

Returns:

the created Document instance

document

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

Description copied from interface: JDOMFactory

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

Specified by:

document in interface JDOMFactory

Parameters:

rootElement - Element for document root.

docType - DocType declaration.

baseURI - the URI from which this doucment was loaded.

Returns:

the created Document instance

document

public Document document(Element rootElement)

Description copied from interface: JDOMFactory

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

Specified by:

document in interface JDOMFactory

Parameters:

rootElement - Element for document root

Returns:

the created Document instance

element

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

Description copied from interface: JDOMFactory

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

Specified by:

element in interface JDOMFactory

Parameters:

name - String name of element.

namespace - Namespace to put element in.

Returns:

the created Element instance

element

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

Description copied from interface: JDOMFactory

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

Specified by:

element in interface JDOMFactory

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

element

public final Element element(java.lang.String name)

Description copied from interface: JDOMFactory

This will create an Element in no Namespace.

Specified by:

element in interface JDOMFactory

Parameters:

name - String name of element.

Returns:

the created Element instance

element

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

Description copied from interface: JDOMFactory

This will create an Element in no Namespace.

Specified by:

element in interface JDOMFactory

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

element

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

Description copied from interface: JDOMFactory

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).

Specified by:

element in interface JDOMFactory

Parameters:

name - String name of element.

uri - String URI for Namespace element should be in.

Returns:

the created Element instance

element

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

Description copied from interface: JDOMFactory

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).

Specified by:

element in interface JDOMFactory

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

element

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

Description copied from interface: JDOMFactory

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.

Specified by:

element in interface JDOMFactory

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

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

Description copied from interface: JDOMFactory

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.

Specified by:

element in interface JDOMFactory

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

processingInstruction

public final ProcessingInstruction processingInstruction(java.lang.String target)

Description copied from interface: JDOMFactory

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

Specified by:

processingInstruction in interface JDOMFactory

Parameters:

target - String target of PI.

Returns:

the created ProcessingInstruction instance

processingInstruction

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

Description copied from interface: JDOMFactory

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

Specified by:

processingInstruction in interface JDOMFactory

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

processingInstruction

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

Description copied from interface: JDOMFactory

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

Specified by:

processingInstruction in interface JDOMFactory

Parameters:

target - String target of PI.

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

Returns:

the created ProcessingInstruction instance

processingInstruction

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

Description copied from interface: JDOMFactory

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

Specified by:

processingInstruction in interface JDOMFactory

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

processingInstruction

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

Description copied from interface: JDOMFactory

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

Specified by:

processingInstruction in interface JDOMFactory

Parameters:

target - String target of PI.

data - String data for PI.

Returns:

the created ProcessingInstruction instance

processingInstruction

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

Description copied from interface: JDOMFactory

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

Specified by:

processingInstruction in interface JDOMFactory

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

entityRef

public final EntityRef entityRef(java.lang.String name)

Description copied from interface: JDOMFactory

This will create a new EntityRef with the supplied name.

Specified by:

entityRef in interface JDOMFactory

Parameters:

name - String name of element.

Returns:

the created EntityRef instance

entityRef

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

Description copied from interface: JDOMFactory

This will create a new EntityRef with the supplied name.

Specified by:

entityRef in interface JDOMFactory

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

entityRef

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

Description copied from interface: JDOMFactory

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

Specified by:

entityRef in interface JDOMFactory

Parameters:

name - String name of element.

publicID - String public ID of element.

systemID - String system ID of element.

Returns:

the created EntityRef instance

entityRef

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

Description copied from interface: JDOMFactory

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

Specified by:

entityRef in interface JDOMFactory

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

entityRef

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

Description copied from interface: JDOMFactory

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

Specified by:

entityRef in interface JDOMFactory

Parameters:

name - String name of element.

systemID - String system ID of element.

Returns:

the created EntityRef instance

entityRef

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

Description copied from interface: JDOMFactory

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

Specified by:

entityRef in interface JDOMFactory

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

addContent

public void addContent(Parent parent,
                       Content child)

Description copied from interface: JDOMFactory

This will add the specified content to the specified parent instance

Specified by:

addContent in interface JDOMFactory

Parameters:

parent - The Parent to add the content to.

child - The Content to add

setAttribute

public void setAttribute(Element parent,
                         Attribute a)

Description copied from interface: JDOMFactory

Sets a specific Attribute on an Element

Specified by:

setAttribute in interface JDOMFactory

Parameters:

parent - The Element to set the Attribute on

a - The Attribute to set

addNamespaceDeclaration

public void addNamespaceDeclaration(Element parent,
                                    Namespace additional)

Description copied from interface: JDOMFactory

Adds a namespace declaration to an Element

Specified by:

addNamespaceDeclaration in interface JDOMFactory

Parameters:

parent - The Element to add the Namespace to

additional - The Namespace to add.

setRoot

public void setRoot(Document doc,
                    Element root)

Description copied from interface: JDOMFactory

Sets the 'root' Element for a Document.

Specified by:

setRoot in interface JDOMFactory

Parameters:

doc - The Document to set the Root Element of.

root - The Element to set as the root.