Package org.jdom
Class DefaultJDOMFactory
- java.lang.Object
-
- org.jdom.DefaultJDOMFactory
-
- All Implemented Interfaces:
JDOMFactory
- Direct Known Subclasses:
LocatedJDOMFactory
,SlimJDOMFactory
,UncheckedJDOMFactory
public class DefaultJDOMFactory extends Object implements JDOMFactory
Creates the standard top-level JDOM classes (Element, Document, Comment, etc). A subclass of this factory might construct custom classes.
-
-
Constructor Summary
Constructors Constructor Description DefaultJDOMFactory()
Creates a new DefaultJDOMFactory instance.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
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 ElementAttribute
attribute(String name, String value)
This will create a newAttribute
with the specified (local) name and value, and does not place the attribute in a
.Namespace
Attribute
attribute(String name, String value, int type)
Deprecated.Attribute
attribute(String name, String value, int type, Namespace namespace)
Deprecated.Attribute
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
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
Attribute
attribute(String name, String value, Namespace namespace)
This will create a newAttribute
with the specified (local) name and value, and in the provided
.Namespace
CDATA
cdata(int line, int col, String text)
This creates the CDATA with the supplied text.CDATA
cdata(String str)
This creates the CDATA with the supplied text.Comment
comment(int line, int col, String text)
This creates the comment with the supplied text.Comment
comment(String text)
This creates the comment with the supplied text.DocType
docType(int line, int col, String elementName)
This will create theDocType
with the specified element nameDocType
docType(int line, int col, String elementName, String systemID)
This will create theDocType
with the specified element name and reference to an external DTD.DocType
docType(int line, int col, String elementName, String publicID, String systemID)
This will create theDocType
with the specified element name and a reference to an external DTD.DocType
docType(String elementName)
This will create theDocType
with the specified element nameDocType
docType(String elementName, String systemID)
This will create theDocType
with the specified element name and reference to an external DTD.DocType
docType(String elementName, String publicID, String systemID)
This will create theDocType
with the specified element name and a reference to an external DTD.Document
document(Element rootElement)
Document
document(Element rootElement, DocType docType)
Document
document(Element rootElement, DocType docType, String baseURI)
Element
element(int line, int col, String name)
This will create anElement
in no
.Namespace
Element
element(int line, int col, String name, String uri)
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).Element
element(int line, int col, String name, String prefix, String uri)
This will create a newElement
with the supplied (local) name, and specifies the prefix and URI of the
theNamespace
Element
should be in.Element
element(int line, int col, String name, Namespace namespace)
This will create a newElement
with the supplied (local) name, and define the
to be used.Namespace
Element
element(String name)
This will create anElement
in no
.Namespace
Element
element(String name, String uri)
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).Element
element(String name, String prefix, String uri)
This will create a newElement
with the supplied (local) name, and specifies the prefix and URI of the
theNamespace
Element
should be in.Element
element(String name, Namespace namespace)
This will create a newElement
with the supplied (local) name, and define the
to be used.Namespace
EntityRef
entityRef(int line, int col, String name)
This will create a newEntityRef
with the supplied name.EntityRef
entityRef(int line, int col, String name, String systemID)
This will create a newEntityRef
with the supplied name and system ID.EntityRef
entityRef(int line, int col, String name, String publicID, String systemID)
This will create a newEntityRef
with the supplied name, public ID, and system ID.EntityRef
entityRef(String name)
This will create a newEntityRef
with the supplied name.EntityRef
entityRef(String name, String systemID)
This will create a newEntityRef
with the supplied name and system ID.EntityRef
entityRef(String name, String publicID, String systemID)
This will create a newEntityRef
with the supplied name, public ID, and system ID.ProcessingInstruction
processingInstruction(int line, int col, String target)
This will create a newProcessingInstruction
with the specified target and no data.ProcessingInstruction
processingInstruction(int line, int col, String target, String data)
This will create a newProcessingInstruction
with the specified target and data.ProcessingInstruction
processingInstruction(int line, int col, String target, Map<String,String> data)
This will create a newProcessingInstruction
with the specified target and data.ProcessingInstruction
processingInstruction(String target)
This will create a newProcessingInstruction
with the specified target and no data.ProcessingInstruction
processingInstruction(String target, String data)
This will create a newProcessingInstruction
with the specified target and data.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
setRoot(Document doc, Element root)
Sets the 'root' Element for a Document.Text
text(int line, int col, String text)
This creates the Text with the supplied text.Text
text(String str)
This creates the Text with the supplied text.
-
-
-
Method Detail
-
attribute
public Attribute attribute(String name, 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 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 public Attribute attribute(String name, String value, int type, Namespace namespace)
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
public Attribute attribute(String name, String value, AttributeType type, Namespace namespace)
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
public Attribute attribute(String name, String value)
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 public Attribute attribute(String name, String value, int type)
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
public Attribute attribute(String name, String value, AttributeType type)
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
public final CDATA cdata(String str)
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
public CDATA cdata(int line, int col, String text)
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
public final Text text(String str)
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
public Text text(int line, int col, String 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
public final Comment comment(String text)
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
public Comment comment(int line, int col, String text)
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
public final DocType docType(String elementName, String publicID, String systemID)
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
public DocType docType(int line, int col, String elementName, String publicID, String systemID)
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
public final DocType docType(String elementName, String systemID)
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
public DocType docType(int line, int col, String elementName, String systemID)
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
public final DocType docType(String elementName)
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
public DocType docType(int line, int col, String elementName)
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
public Document document(Element rootElement, DocType docType)
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
public Document document(Element rootElement, DocType docType, String baseURI)
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 doucment was loaded.- Returns:
- the created Document instance
-
document
public Document document(Element rootElement)
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
public Element element(String name, Namespace namespace)
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
public Element element(int line, int col, String name, Namespace namespace)
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
public Element element(String name)
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
public Element element(int line, int col, String name)
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
public Element element(String name, String uri)
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
public Element element(int line, int col, String name, String uri)
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
public Element element(String name, String prefix, String uri)
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
public Element element(int line, int col, String name, String prefix, String uri)
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
public final ProcessingInstruction processingInstruction(String target)
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
public ProcessingInstruction processingInstruction(int line, int col, String target)
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
public final ProcessingInstruction processingInstruction(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:
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
public final ProcessingInstruction processingInstruction(String target, String data)
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
public ProcessingInstruction processingInstruction(int line, int col, String target, 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
-String
data for PI.- Returns:
- the created ProcessingInstruction instance
-
entityRef
public final EntityRef entityRef(String name)
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
public EntityRef entityRef(int line, int col, String name)
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
public final EntityRef entityRef(String name, String publicID, String systemID)
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
public EntityRef entityRef(int line, int col, String name, String publicID, String systemID)
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
public final EntityRef entityRef(String name, String systemID)
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
public EntityRef entityRef(int line, int col, String name, String systemID)
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
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 interfaceJDOMFactory
- Parameters:
parent
- TheParent
to add the content to.child
- TheContent
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 interfaceJDOMFactory
- Parameters:
parent
- TheElement
to set the Attribute ona
- TheAttribute
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 interfaceJDOMFactory
- Parameters:
parent
- TheElement
to add the Namespace toadditional
- TheNamespace
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 interfaceJDOMFactory
- Parameters:
doc
- TheDocument
to set the Root Element of.root
- TheElement
to set as the root.
-
-