Package org.jdom
Interface JDOMFactory
-
- All Known Implementing Classes:
DefaultJDOMFactory
,UncheckedJDOMFactory
public interface JDOMFactory
An interface to be used by builders when constructing JDOM objects. TheDefaultJDOMFactory
creates the standard top-level JDOM classes (Element, Document, Comment, etc). Another implementation of this factory could be used to create custom classes.- Version:
- $Revision: 1.9 $, $Date: 2007/11/10 05:28:59 $
- Author:
- Ken Rune Holland, Phil Nelson, Bradley S. Huffman
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addContent(Parent parent, Content content)
void
addNamespaceDeclaration(Element element, Namespace additional)
Attribute
attribute(java.lang.String name, java.lang.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(java.lang.String name, java.lang.String value, int 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(java.lang.String name, java.lang.String value, int type, Namespace namespace)
This will create a newAttribute
with the specified (local) name, value, and type, and in the provided
.Namespace
Attribute
attribute(java.lang.String name, java.lang.String value, Namespace namespace)
This will create a newAttribute
with the specified (local) name and value, and in the provided
.Namespace
CDATA
cdata(java.lang.String str)
This creates the CDATA with the supplied text.Comment
comment(java.lang.String text)
This creates the comment with the supplied text.DocType
docType(java.lang.String elementName)
This will create theDocType
with the specified element nameDocType
docType(java.lang.String elementName, java.lang.String systemID)
This will create theDocType
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 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, java.lang.String baseURI)
Element
element(java.lang.String name)
This will create anElement
in no
.Namespace
Element
element(java.lang.String name, java.lang.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(java.lang.String name, java.lang.String prefix, java.lang.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(java.lang.String name, Namespace namespace)
This will create a newElement
with the supplied (local) name, and define the
to be used.Namespace
EntityRef
entityRef(java.lang.String name)
This will create a newEntityRef
with the supplied name.EntityRef
entityRef(java.lang.String name, java.lang.String systemID)
This will create a newEntityRef
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 newEntityRef
with the supplied name, public ID, and system ID.ProcessingInstruction
processingInstruction(java.lang.String target, java.lang.String data)
This will create a newProcessingInstruction
with the specified target and data.ProcessingInstruction
processingInstruction(java.lang.String target, java.util.Map data)
This will create a newProcessingInstruction
with the specified target and data.void
setAttribute(Element element, Attribute a)
Text
text(java.lang.String str)
This creates the Text with the supplied text.
-
-
-
Method Detail
-
attribute
Attribute attribute(java.lang.String name, java.lang.String value, Namespace namespace)
This will create a new
Attribute
with the specified (local) name and value, and in the provided
.Namespace
- Parameters:
name
-String
name ofAttribute
.value
-String
value for new attribute.
-
attribute
Attribute attribute(java.lang.String name, java.lang.String value, int type, Namespace namespace)
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.
-
attribute
Attribute attribute(java.lang.String name, java.lang.String value)
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.
-
attribute
Attribute attribute(java.lang.String name, java.lang.String value, int type)
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.
-
cdata
CDATA cdata(java.lang.String str)
This creates the CDATA with the supplied text.- Parameters:
str
-String
content of CDATA.
-
text
Text text(java.lang.String str)
This creates the Text with the supplied text.- Parameters:
str
-String
content of Text.
-
comment
Comment comment(java.lang.String text)
This creates the comment with the supplied text.- Parameters:
text
-String
content of comment.
-
docType
DocType docType(java.lang.String elementName, java.lang.String publicID, java.lang.String systemID)
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
-
docType
DocType docType(java.lang.String elementName, java.lang.String systemID)
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
-
docType
DocType docType(java.lang.String elementName)
This will create theDocType
with the specified element name- Parameters:
elementName
-String
name of element being constrained.
-
document
Document document(Element rootElement, DocType docType)
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.
-
document
Document document(Element rootElement, DocType docType, java.lang.String baseURI)
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 doucment was loaded.
-
document
Document document(Element rootElement)
This will create a newDocument
, with the supplied
as the root element, and noElement
declaration.DocType
- Parameters:
rootElement
-Element
for document root
-
element
Element element(java.lang.String name, Namespace namespace)
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.
-
element
Element element(java.lang.String name)
This will create anElement
in no
.Namespace
- Parameters:
name
-String
name of element.
-
element
Element element(java.lang.String name, java.lang.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).- Parameters:
name
-String
name of element.uri
-String
URI forNamespace
element should be in.
-
element
Element element(java.lang.String name, java.lang.String prefix, java.lang.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.- Parameters:
name
-String
name of element.uri
-String
URI forNamespace
element should be in.
-
processingInstruction
ProcessingInstruction processingInstruction(java.lang.String target, java.util.Map data)
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
-
processingInstruction
ProcessingInstruction processingInstruction(java.lang.String target, java.lang.String data)
This will create a newProcessingInstruction
with the specified target and data.- Parameters:
target
-String
target of PI.data
-String
data for PI.
-
entityRef
EntityRef entityRef(java.lang.String name)
This will create a newEntityRef
with the supplied name.- Parameters:
name
-String
name of element.
-
entityRef
EntityRef entityRef(java.lang.String name, java.lang.String publicID, java.lang.String systemID)
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.
-
entityRef
EntityRef entityRef(java.lang.String name, java.lang.String systemID)
This will create a newEntityRef
with the supplied name and system ID.- Parameters:
name
-String
name of element.systemID
-String
system ID of element.
-
-