Package 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
Modifier and TypeMethodDescriptionvoid
addContent
(Parent parent, Content content) This will add the specified content to the specified parent instancevoid
addNamespaceDeclaration
(Element element, 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.This creates the CDATA with the supplied text.This creates the comment with the supplied text.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.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.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
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
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.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.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.processingInstruction
(String target) This will create a newProcessingInstruction
with the specified target and no data.processingInstruction
(String target, String data) This will create a newProcessingInstruction
with the specified target and data.processingInstruction
(String target, Map<String, String> data) This will create a newProcessingInstruction
with the specified target and data.void
setAttribute
(Element element, Attribute a) Sets a specific Attribute on an Elementvoid
Sets the 'root' Element for a Document.This creates the Text with the supplied text.This creates the Text with the supplied text.
-
Method Details
-
attribute
This will create a new
Attribute
with the specified (local) name and value, and in the provided
.Namespace
- Parameters:
name
-String
name ofAttribute
.value
-String
value for new attribute.namespace
-Namespace
of the new Attribute- Returns:
- the created Attribute instance
-
attribute
Deprecated.This will create a newAttribute
with the specified (local) name, value, and type, and in the provided
.Namespace
- 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
This will create a newAttribute
with the specified (local) name, value, and type, and in the provided
.Namespace
- 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
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
- Parameters:
name
-String
name ofAttribute
.value
-String
value for new attribute.- Returns:
- the created Attribute instance
-
attribute
Deprecated.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
- Parameters:
name
-String
name ofAttribute
.value
-String
value for new attribute.type
-int
type for new attribute.- Returns:
- the created Attribute instance
-
attribute
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
- Parameters:
name
-String
name ofAttribute
.value
-String
value for new attribute.type
-AttributeType
type for new attribute.- Returns:
- the created Attribute instance
-
cdata
This creates the CDATA with the supplied text.- Parameters:
str
-String
content of CDATA.- Returns:
- the created CDATA instance
-
cdata
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
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
This creates the Text with the supplied text.- Parameters:
str
-String
content of Text.- Returns:
- the created Text instance
-
comment
This creates the comment with the supplied text.- Parameters:
text
-String
content of comment.- Returns:
- the created Comment instance
-
comment
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
This will create theDocType
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 DTDsystemID
-String
system ID of referenced DTD- Returns:
- the created DocType instance
-
docType
This will create theDocType
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
This will create theDocType
with the specified element name- Parameters:
elementName
-String
name of element being constrained.- Returns:
- the created DocType instance
-
docType
This will create theDocType
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 DTDsystemID
-String
system ID of referenced DTD- Returns:
- the created DocType instance
- Since:
- JDOM2
-
docType
This will create theDocType
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
This will create theDocType
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
This will create a newDocument
, with the supplied
as the root element and the suppliedElement
declaration.DocType
- Parameters:
rootElement
-Element
for document root.docType
-DocType
declaration.- Returns:
- the created Document instance
-
document
This will create a newDocument
, with the supplied
as the root element and the suppliedElement
declaration.DocType
- Parameters:
rootElement
-Element
for document root.docType
-DocType
declaration.baseURI
- the URI from which this document was loaded.- Returns:
- the created Document instance
-
document
This will create a newDocument
, with the supplied
as the root element, and noElement
declaration.DocType
- Parameters:
rootElement
-Element
for document root- Returns:
- the created Document instance
-
element
This will create a newElement
with the supplied (local) name, and define the
to be used.Namespace
- Parameters:
name
-String
name of element.namespace
-Namespace
to put element in.- Returns:
- the created Element instance
-
element
This will create anElement
in no
.Namespace
- Parameters:
name
-String
name of element.- Returns:
- the created Element instance
-
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).- Parameters:
name
-String
name of element.uri
-String
URI forNamespace
element should be in.- Returns:
- the created Element instance
-
element
This will create a newElement
with the supplied (local) name, and specifies the prefix and URI of the
theNamespace
Element
should be in.- 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
This will create a newElement
with the supplied (local) name, and define the
to be used.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.namespace
-Namespace
to put element in.- Returns:
- the created Element instance
- Since:
- JDOM2
-
element
This will create anElement
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
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).- 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
- Since:
- JDOM2
-
element
This will create a newElement
with the supplied (local) name, and specifies the prefix and URI of the
theNamespace
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 Elementuri
-String
URI forNamespace
element should be in.- Returns:
- the created Element instance
- Since:
- JDOM2
-
processingInstruction
This will create a newProcessingInstruction
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
This will create a newProcessingInstruction
with the specified target and data.- Parameters:
target
-String
target of PI.data
-String
data for PI.- Returns:
- the created ProcessingInstruction instance
-
processingInstruction
This will create a newProcessingInstruction
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, String target, Map<String, String> data) This will create a newProcessingInstruction
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
This will create a newProcessingInstruction
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
This will create a newProcessingInstruction
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
This will create a newEntityRef
with the supplied name.- Parameters:
name
-String
name of element.- Returns:
- the created EntityRef instance
-
entityRef
This will create a newEntityRef
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
This will create a newEntityRef
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
This will create a newEntityRef
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
This will create a newEntityRef
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
This will create a newEntityRef
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
This will add the specified content to the specified parent instance -
setAttribute
Sets a specific Attribute on an Element -
addNamespaceDeclaration
Adds a namespace declaration to an Element -
setRoot
Sets the 'root' Element for a Document.
-
attribute(String, String, AttributeType)