Package org.jdom2
Class DefaultJDOMFactory
java.lang.Object
org.jdom2.DefaultJDOMFactory
- All Implemented Interfaces:
JDOMFactory
- Direct Known Subclasses:
LocatedJDOMFactory
,SlimJDOMFactory
,UncheckedJDOMFactory
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
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addContent
(Parent parent, Content child) This will add the specified content to the specified parent instancevoid
addNamespaceDeclaration
(Element parent, Namespace additional) Adds a namespace declaration to an ElementThis will create a newAttribute
with the specified (local) name and value, and does not place the attribute in a
.Namespace
Deprecated.Deprecated.attribute
(String name, String value, AttributeType type) This will create a newAttribute
with the specified (local) name, value and type, and does not place the attribute in a
.Namespace
attribute
(String name, String value, AttributeType type, Namespace namespace) This will create a newAttribute
with the specified (local) name, value, and type, and in the provided
.Namespace
This will create a newAttribute
with the specified (local) name and value, and in the provided
.Namespace
This creates the CDATA with the supplied text.final CDATA
This creates the CDATA with the supplied text.This creates the comment with the supplied text.final Comment
This creates the comment with the supplied text.This will create theDocType
with the specified element nameThis will create theDocType
with the specified element name and reference to an external DTD.This will create theDocType
with the specified element name and a reference to an external DTD.final DocType
This will create theDocType
with the specified element namefinal DocType
This will create theDocType
with the specified element name and reference to an external DTD.final DocType
This will create theDocType
with the specified element name and a reference to an external DTD.This will create anElement
in no
.Namespace
This will create a newElement
with the supplied (local) name, and specifies the URI of the
theNamespace
Element
should be in, resulting it being unprefixed (in the default namespace).This will create a newElement
with the supplied (local) name, and specifies the prefix and URI of the
theNamespace
Element
should be in.This will create a newElement
with the supplied (local) name, and define the
to be used.Namespace
final Element
This will create anElement
in no
.Namespace
final Element
This will create a newElement
with the supplied (local) name, and specifies the URI of the
theNamespace
Element
should be in, resulting it being unprefixed (in the default namespace).final Element
This will create a newElement
with the supplied (local) name, and specifies the prefix and URI of the
theNamespace
Element
should be in.final Element
This will create a newElement
with the supplied (local) name, and define the
to be used.Namespace
This will create a newEntityRef
with the supplied name.This will create a newEntityRef
with the supplied name and system ID.This will create a newEntityRef
with the supplied name, public ID, and system ID.final EntityRef
This will create a newEntityRef
with the supplied name.final EntityRef
This will create a newEntityRef
with the supplied name and system ID.final EntityRef
This will create a newEntityRef
with the supplied name, public ID, and system ID.processingInstruction
(int line, int col, String target) This will create a newProcessingInstruction
with the specified target and no data.processingInstruction
(int line, int col, String target, String data) This will create a newProcessingInstruction
with the specified target and data.processingInstruction
(int line, int col, String target, Map<String, String> data) This will create a newProcessingInstruction
with the specified target and data.final ProcessingInstruction
processingInstruction
(String target) This will create a newProcessingInstruction
with the specified target and no data.final ProcessingInstruction
processingInstruction
(String target, String data) This will create a newProcessingInstruction
with the specified target and data.final ProcessingInstruction
processingInstruction
(String target, Map<String, String> data) This will create a newProcessingInstruction
with the specified target and data.void
setAttribute
(Element parent, Attribute a) Sets a specific Attribute on an Elementvoid
Sets the 'root' Element for a Document.This creates the Text with the supplied text.final Text
This creates the Text with the supplied text.
-
Constructor Details
-
DefaultJDOMFactory
public DefaultJDOMFactory()Creates a new DefaultJDOMFactory instance.
-
-
Method Details
-
attribute
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 interfaceJDOMFactory
- Parameters:
name
-String
name ofAttribute
.value
-String
value for new attribute.namespace
-Namespace
of the new Attribute- Returns:
- the created Attribute instance
-
attribute
Deprecated.Description copied from interface:JDOMFactory
This will create a newAttribute
with the specified (local) name, value, and type, and in the provided
.Namespace
- Specified by:
attribute
in interfaceJDOMFactory
- Parameters:
name
-String
name ofAttribute
.value
-String
value for new attribute.type
-int
type for new attribute.namespace
-Namespace
namespace for new attribute.- Returns:
- the created Attribute instance
-
attribute
Description copied from interface:JDOMFactory
This will create a newAttribute
with the specified (local) name, value, and type, and in the provided
.Namespace
- Specified by:
attribute
in interfaceJDOMFactory
- Parameters:
name
-String
name ofAttribute
.value
-String
value for new attribute.type
-AttributeType
type for new attribute.namespace
-Namespace
namespace for new attribute.- Returns:
- the created Attribute instance
-
attribute
Description copied from interface:JDOMFactory
This will create a newAttribute
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 interfaceJDOMFactory
- Parameters:
name
-String
name ofAttribute
.value
-String
value for new attribute.- Returns:
- the created Attribute instance
-
attribute
Deprecated.Description copied from interface:JDOMFactory
This will create a newAttribute
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 interfaceJDOMFactory
- Parameters:
name
-String
name ofAttribute
.value
-String
value for new attribute.type
-int
type for new attribute.- Returns:
- the created Attribute instance
-
attribute
Description copied from interface:JDOMFactory
This will create a newAttribute
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 interfaceJDOMFactory
- Parameters:
name
-String
name ofAttribute
.value
-String
value for new attribute.type
-AttributeType
type for new attribute.- Returns:
- the created Attribute instance
-
cdata
Description copied from interface:JDOMFactory
This creates the CDATA with the supplied text.- Specified by:
cdata
in interfaceJDOMFactory
- Parameters:
str
-String
content of CDATA.- Returns:
- the created CDATA instance
-
cdata
Description copied from interface:JDOMFactory
This creates the CDATA with the supplied text.- Specified by:
cdata
in interfaceJDOMFactory
- 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
Description copied from interface:JDOMFactory
This creates the Text with the supplied text.- Specified by:
text
in interfaceJDOMFactory
- Parameters:
str
-String
content of Text.- Returns:
- the created Text instance
-
text
Description copied from interface:JDOMFactory
This creates the Text with the supplied text.- Specified by:
text
in interfaceJDOMFactory
- 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
Description copied from interface:JDOMFactory
This creates the comment with the supplied text.- Specified by:
comment
in interfaceJDOMFactory
- Parameters:
text
-String
content of comment.- Returns:
- the created Comment instance
-
comment
Description copied from interface:JDOMFactory
This creates the comment with the supplied text.- Specified by:
comment
in interfaceJDOMFactory
- 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
Description copied from interface:JDOMFactory
This will create theDocType
with the specified element name and a reference to an external DTD.- Specified by:
docType
in interfaceJDOMFactory
- Parameters:
elementName
-String
name of element being constrained.publicID
-String
public ID of referenced DTDsystemID
-String
system ID of referenced DTD- Returns:
- the created DocType instance
-
docType
Description copied from interface:JDOMFactory
This will create theDocType
with the specified element name and a reference to an external DTD.- Specified by:
docType
in interfaceJDOMFactory
- 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 DTDsystemID
-String
system ID of referenced DTD- Returns:
- the created DocType instance
-
docType
Description copied from interface:JDOMFactory
This will create theDocType
with the specified element name and reference to an external DTD.- Specified by:
docType
in interfaceJDOMFactory
- Parameters:
elementName
-String
name of element being constrained.systemID
-String
system ID of referenced DTD- Returns:
- the created DocType instance
-
docType
Description copied from interface:JDOMFactory
This will create theDocType
with the specified element name and reference to an external DTD.- Specified by:
docType
in interfaceJDOMFactory
- 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
Description copied from interface:JDOMFactory
This will create theDocType
with the specified element name- Specified by:
docType
in interfaceJDOMFactory
- Parameters:
elementName
-String
name of element being constrained.- Returns:
- the created DocType instance
-
docType
Description copied from interface:JDOMFactory
This will create theDocType
with the specified element name- Specified by:
docType
in interfaceJDOMFactory
- 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
Description copied from interface:JDOMFactory
This will create a newDocument
, with the supplied
as the root element and the suppliedElement
declaration.DocType
- Specified by:
document
in interfaceJDOMFactory
- Parameters:
rootElement
-Element
for document root.docType
-DocType
declaration.- Returns:
- the created Document instance
-
document
Description copied from interface:JDOMFactory
This will create a newDocument
, with the supplied
as the root element and the suppliedElement
declaration.DocType
- Specified by:
document
in interfaceJDOMFactory
- Parameters:
rootElement
-Element
for document root.docType
-DocType
declaration.baseURI
- the URI from which this document was loaded.- Returns:
- the created Document instance
-
document
Description copied from interface:JDOMFactory
This will create a newDocument
, with the supplied
as the root element, and noElement
declaration.DocType
- Specified by:
document
in interfaceJDOMFactory
- Parameters:
rootElement
-Element
for document root- Returns:
- the created Document instance
-
element
Description copied from interface:JDOMFactory
This will create a newElement
with the supplied (local) name, and define the
to be used.Namespace
- Specified by:
element
in interfaceJDOMFactory
- Parameters:
name
-String
name of element.namespace
-Namespace
to put element in.- Returns:
- the created Element instance
-
element
Description copied from interface:JDOMFactory
This will create a newElement
with the supplied (local) name, and define the
to be used.Namespace
- Specified by:
element
in interfaceJDOMFactory
- 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
Description copied from interface:JDOMFactory
This will create anElement
in no
.Namespace
- Specified by:
element
in interfaceJDOMFactory
- Parameters:
name
-String
name of element.- Returns:
- the created Element instance
-
element
Description copied from interface:JDOMFactory
This will create anElement
in no
.Namespace
- Specified by:
element
in interfaceJDOMFactory
- 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
Description copied from interface:JDOMFactory
This will create a newElement
with the supplied (local) name, and specifies the URI of the
theNamespace
Element
should be in, resulting it being unprefixed (in the default namespace).- Specified by:
element
in interfaceJDOMFactory
- Parameters:
name
-String
name of element.uri
-String
URI forNamespace
element should be in.- Returns:
- the created Element instance
-
element
Description copied from interface:JDOMFactory
This will create a newElement
with the supplied (local) name, and specifies the URI of the
theNamespace
Element
should be in, resulting it being unprefixed (in the default namespace).- Specified by:
element
in interfaceJDOMFactory
- 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 forNamespace
element should be in.- Returns:
- the created Element instance
-
element
Description copied from interface:JDOMFactory
This will create a newElement
with the supplied (local) name, and specifies the prefix and URI of the
theNamespace
Element
should be in.- Specified by:
element
in interfaceJDOMFactory
- Parameters:
name
-String
name of element.prefix
- the NamespacePrefic to use for this Elementuri
-String
URI forNamespace
element should be in.- Returns:
- the created Element instance
-
element
Description copied from interface:JDOMFactory
This will create a newElement
with the supplied (local) name, and specifies the prefix and URI of the
theNamespace
Element
should be in.- Specified by:
element
in interfaceJDOMFactory
- 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 Elementuri
-String
URI forNamespace
element should be in.- Returns:
- the created Element instance
-
processingInstruction
Description copied from interface:JDOMFactory
This will create a newProcessingInstruction
with the specified target and no data.- Specified by:
processingInstruction
in interfaceJDOMFactory
- Parameters:
target
-String
target of PI.- Returns:
- the created ProcessingInstruction instance
-
processingInstruction
Description copied from interface:JDOMFactory
This will create a newProcessingInstruction
with the specified target and no data.- Specified by:
processingInstruction
in interfaceJDOMFactory
- 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
Description copied from interface:JDOMFactory
This will create a newProcessingInstruction
with the specified target and data.- Specified by:
processingInstruction
in interfaceJDOMFactory
- 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, String target, Map<String, String> data) Description copied from interface:JDOMFactory
This will create a newProcessingInstruction
with the specified target and data.- Specified by:
processingInstruction
in interfaceJDOMFactory
- 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
Description copied from interface:JDOMFactory
This will create a newProcessingInstruction
with the specified target and data.- Specified by:
processingInstruction
in interfaceJDOMFactory
- Parameters:
target
-String
target of PI.data
-String
data for PI.- Returns:
- the created ProcessingInstruction instance
-
processingInstruction
Description copied from interface:JDOMFactory
This will create a newProcessingInstruction
with the specified target and data.- Specified by:
processingInstruction
in interfaceJDOMFactory
- 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
Description copied from interface:JDOMFactory
This will create a newEntityRef
with the supplied name.- Specified by:
entityRef
in interfaceJDOMFactory
- Parameters:
name
-String
name of element.- Returns:
- the created EntityRef instance
-
entityRef
Description copied from interface:JDOMFactory
This will create a newEntityRef
with the supplied name.- Specified by:
entityRef
in interfaceJDOMFactory
- 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
Description copied from interface:JDOMFactory
This will create a newEntityRef
with the supplied name, public ID, and system ID.- Specified by:
entityRef
in interfaceJDOMFactory
- Parameters:
name
-String
name of element.publicID
-String
public ID of element.systemID
-String
system ID of element.- Returns:
- the created EntityRef instance
-
entityRef
Description copied from interface:JDOMFactory
This will create a newEntityRef
with the supplied name, public ID, and system ID.- Specified by:
entityRef
in interfaceJDOMFactory
- 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
Description copied from interface:JDOMFactory
This will create a newEntityRef
with the supplied name and system ID.- Specified by:
entityRef
in interfaceJDOMFactory
- Parameters:
name
-String
name of element.systemID
-String
system ID of element.- Returns:
- the created EntityRef instance
-
entityRef
Description copied from interface:JDOMFactory
This will create a newEntityRef
with the supplied name and system ID.- Specified by:
entityRef
in interfaceJDOMFactory
- 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
Description copied from interface:JDOMFactory
This will add the specified content to the specified parent instance- Specified by:
addContent
in interfaceJDOMFactory
- Parameters:
parent
- TheParent
to add the content to.child
- TheContent
to add
-
setAttribute
Description copied from interface:JDOMFactory
Sets a specific Attribute on an Element- Specified by:
setAttribute
in interfaceJDOMFactory
- Parameters:
parent
- TheElement
to set the Attribute ona
- TheAttribute
to set
-
addNamespaceDeclaration
Description copied from interface:JDOMFactory
Adds a namespace declaration to an Element- Specified by:
addNamespaceDeclaration
in interfaceJDOMFactory
- Parameters:
parent
- TheElement
to add the Namespace toadditional
- TheNamespace
to add.
-
setRoot
Description copied from interface:JDOMFactory
Sets the 'root' Element for a Document.- Specified by:
setRoot
in interfaceJDOMFactory
- Parameters:
doc
- TheDocument
to set the Root Element of.root
- TheElement
to set as the root.
-