org.jdom

Interface JDOMFactory

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.

Version: $Revision: 1.8 $, $Date: 2004/09/01 05:25:38 $

Author: Ken Rune Holland Phil Nelson Bradley S. Huffman

Method Summary
void	addContent(Parent parent, Content content)
void	addNamespaceDeclaration(Element element, Namespace additional)
Attribute	attribute(String name, String value, Namespace namespace) This will create a new `Attribute` with the specified (local) name and value, and in the provided `{@link org.jdom.Namespace}`.
Attribute	attribute(String name, String value, int type, Namespace namespace) This will create a new `Attribute` with the specified (local) name, value, and type, and in the provided `{@link org.jdom.Namespace}`.
Attribute	attribute(String name, String value) This will create a new `Attribute` with the specified (local) name and value, and does not place the attribute in a `{@link org.jdom.Namespace}`.
Attribute	attribute(String name, String value, int type) This will create a new `Attribute` with the specified (local) name, value and type, and does not place the attribute in a `{@link org.jdom.Namespace}`.
CDATA	cdata(String str) This creates the CDATA with the supplied text.
Comment	comment(String text) This creates the comment with the supplied text.
DocType	docType(String elementName, String publicID, String systemID) This will create the `DocType` with the specified element name and a reference to an external DTD.
DocType	docType(String elementName, String systemID) This will create the `DocType` with the specified element name and reference to an external DTD.
DocType	docType(String elementName) This will create the `DocType` with the specified element name
Document	document(Element rootElement, DocType docType) This will create a new `Document`, with the supplied `{@link org.jdom.Element}` as the root element and the supplied `{@link org.jdom.DocType}` declaration.
Document	document(Element rootElement, DocType docType, String baseURI) This will create a new `Document`, with the supplied `{@link org.jdom.Element}` as the root element and the supplied `{@link org.jdom.DocType}` declaration.
Document	document(Element rootElement) This will create a new `Document`, with the supplied `{@link org.jdom.Element}` as the root element, and no `{@link org.jdom.DocType}` declaration.
Element	element(String name, Namespace namespace) This will create a new `Element` with the supplied (local) name, and define the `{@link org.jdom.Namespace}` to be used.
Element	element(String name) This will create an `Element` in no `{@link org.jdom.Namespace}`.
Element	element(String name, String uri) This will create a new `Element` with the supplied (local) name, and specifies the URI of the `{@link org.jdom.Namespace}` the `Element` should be in, resulting it being unprefixed (in the default namespace).
Element	element(String name, String prefix, String uri) This will create a new `Element` with the supplied (local) name, and specifies the prefix and URI of the `{@link org.jdom.Namespace}` the `Element` should be in.
EntityRef	entityRef(String name) This will create a new `EntityRef` with the supplied name.
EntityRef	entityRef(String name, String publicID, String systemID) This will create a new `EntityRef` with the supplied name, public ID, and system ID.
EntityRef	entityRef(String name, String systemID) This will create a new `EntityRef` with the supplied name and system ID.
ProcessingInstruction	processingInstruction(String target, Map data) This will create a new `ProcessingInstruction` with the specified target and data.
ProcessingInstruction	processingInstruction(String target, String data) This will create a new `ProcessingInstruction` with the specified target and data.
void	setAttribute(Element element, Attribute a)
Text	text(String str) This creates the Text with the supplied text.

Method Detail

addContent

public void addContent(Parent parent, Content content)

addNamespaceDeclaration

public void addNamespaceDeclaration(Element element, Namespace additional)

attribute

public Attribute attribute(String name, String value, Namespace namespace)

This will create a new Attribute with the specified (local) name and value, and in the provided {@link org.jdom.Namespace}.

Parameters: name String name of Attribute. value String value for new attribute.

attribute

public Attribute attribute(String name, String value, int type, Namespace namespace)

This will create a new Attribute with the specified (local) name, value, and type, and in the provided {@link org.jdom.Namespace}.

Parameters: name String name of Attribute. value String value for new attribute. type int type for new attribute. namespace Namespace namespace for new attribute.

attribute

public Attribute attribute(String name, String value)

This will create a new Attribute with the specified (local) name and value, and does not place the attribute in a {@link org.jdom.Namespace}.

Note: This actually explicitly puts the Attribute in the "empty" Namespace ({@link org.jdom.Namespace#NO_NAMESPACE}).

Parameters: name String name of Attribute. value String value for new attribute.

attribute

public Attribute attribute(String name, String value, int type)

This will create a new Attribute with the specified (local) name, value and type, and does not place the attribute in a {@link org.jdom.Namespace}.

Note: This actually explicitly puts the Attribute in the "empty" Namespace ({@link org.jdom.Namespace#NO_NAMESPACE}).

Parameters: name String name of Attribute. value String value for new attribute. type int type for new attribute.

cdata

public CDATA cdata(String str)

This creates the CDATA with the supplied text.

Parameters: str String content of CDATA.

comment

public Comment comment(String text)

This creates the comment with the supplied text.

Parameters: text String content of comment.

docType

public DocType docType(String elementName, String publicID, String systemID)

This will create the DocType 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 DTD systemID String system ID of referenced DTD

docType

public DocType docType(String elementName, String systemID)

This will create the DocType 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

public DocType docType(String elementName)

This will create the DocType with the specified element name

Parameters: elementName String name of element being constrained.

document

public Document document(Element rootElement, DocType docType)

This will create a new Document, with the supplied {@link org.jdom.Element} as the root element and the supplied {@link org.jdom.DocType} declaration.

Parameters: rootElement Element for document root. docType DocType declaration.

document

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

This will create a new Document, with the supplied {@link org.jdom.Element} as the root element and the supplied {@link org.jdom.DocType} declaration.

Parameters: rootElement Element for document root. docType DocType declaration. baseURI the URI from which this doucment was loaded.

document

public Document document(Element rootElement)

This will create a new Document, with the supplied {@link org.jdom.Element} as the root element, and no {@link org.jdom.DocType} declaration.

Parameters: rootElement Element for document root

element

public Element element(String name, Namespace namespace)

This will create a new Element with the supplied (local) name, and define the {@link org.jdom.Namespace} to be used.

Parameters: name String name of element. namespace Namespace to put element in.

element

public Element element(String name)

This will create an Element in no {@link org.jdom.Namespace}.

Parameters: name String name of element.

element

public Element element(String name, String uri)

This will create a new Element with the supplied (local) name, and specifies the URI of the {@link org.jdom.Namespace} the Element should be in, resulting it being unprefixed (in the default namespace).

Parameters: name String name of element. uri String URI for Namespace element should be in.

element

public Element element(String name, String prefix, String uri)

This will create a new Element with the supplied (local) name, and specifies the prefix and URI of the {@link org.jdom.Namespace} the Element should be in.

Parameters: name String name of element. uri String URI for Namespace element should be in.

entityRef

public EntityRef entityRef(String name)

This will create a new EntityRef with the supplied name.

Parameters: name String name of element.

entityRef

public EntityRef entityRef(String name, String publicID, String systemID)

This will create a new EntityRef 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

public EntityRef entityRef(String name, String systemID)

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

Parameters: name String name of element. systemID String system ID of element.

processingInstruction

public ProcessingInstruction processingInstruction(String target, Map data)

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

Parameters: target String target of PI. data Map data for PI, in name/value pairs

processingInstruction

public ProcessingInstruction processingInstruction(String target, String data)

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

Parameters: target String target of PI. data String data for PI.

setAttribute

public void setAttribute(Element element, Attribute a)

text

public Text text(String str)

This creates the Text with the supplied text.

Parameters: str String content of Text.