---

JDOMFactory Interface Reference

Inheritance diagram for JDOMFactory::

List of all members.

Public Methods
Attribute	attribute (String name, String value, Namespace namespace)
Attribute	attribute (String name, String value, int type, Namespace namespace)
Attribute	attribute (String name, String value)
Attribute	attribute (String name, String value, int type)
CDATA	cdata (String str)
Text	text (String str)
Comment	comment (String text)
DocType	docType (String elementName, String publicID, String systemID)
DocType	docType (String elementName, String systemID)
DocType	docType (String elementName)
Document	document (Element rootElement, DocType docType)
Document	document (Element rootElement)
Element	element (String name, Namespace namespace)
Element	element (String name)
Element	element (String name, String uri)
Element	element (String name, String prefix, String uri)
ProcessingInstruction	processingInstruction (String target, Map data)
ProcessingInstruction	processingInstruction (String target, String data)
EntityRef	entityRef (String name)
EntityRef	entityRef (String name, String publicID, String systemID)

---

Detailed Description

JDOMFactory is an interface to be used by builders in 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

Version:

Revision:

1.5

,

Date:

2002/01/08 09:17:10

---

Member Function Documentation

Attribute JDOMFactory::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 Namespace. Note: This actually explicitly puts the Attribute in the "empty" Namespace (Namespace::NO_NAMESPACE). Parameters: name  String name of Attribute. value  String value for new attribute. type  int type for new attribute. Reimplemented in DefaultJDOMFactory.

Attribute JDOMFactory::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 Namespace. Note: This actually explicitly puts the Attribute in the "empty" Namespace (Namespace::NO_NAMESPACE). Parameters: name  String name of Attribute. value  String value for new attribute. Reimplemented in DefaultJDOMFactory.

Attribute JDOMFactory::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 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. Reimplemented in DefaultJDOMFactory.

Attribute JDOMFactory::attribute (  String    name, 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 of Attribute. value  String value for new attribute. Reimplemented in DefaultJDOMFactory.

CDATA JDOMFactory::cdata (  String    text )

This creates the CDATA with the supplied text. Parameters: str  String content of CDATA. Reimplemented in DefaultJDOMFactory.

Comment JDOMFactory::comment (  String    text )

This creates the comment with the supplied text. Parameters: text  String content of comment. Reimplemented in DefaultJDOMFactory.

DocType JDOMFactory::docType (  String    elementName )

This will create the DocType with the specified element name Parameters: elementName  String name of element being constrained. Reimplemented in DefaultJDOMFactory.

DocType JDOMFactory::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 Reimplemented in DefaultJDOMFactory.

DocType JDOMFactory::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 Reimplemented in DefaultJDOMFactory.

Document JDOMFactory::document (  Element    rootElement )

This will create a new Document, with the supplied Element as the root element, and no DocType declaration. Parameters: rootElement  Element for document root Reimplemented in DefaultJDOMFactory.

Document JDOMFactory::document (  Element    rootElement, DocType    docType )

This will create a new Document, with the supplied Element as the root element and the supplied DocType declaration. Parameters: rootElement  Element for document root. docType  DocType declaration. Reimplemented in DefaultJDOMFactory.

Element JDOMFactory::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 Namespace the Element should be in. Parameters: name  String name of element. uri  String URI for Namespace element should be in. Reimplemented in DefaultJDOMFactory.

Element JDOMFactory::element (  String    name, String    uri )

This will create a new Element with the supplied (local) name, and specifies the URI of the 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. Reimplemented in DefaultJDOMFactory.

Element JDOMFactory::element (  String    name )

This will create an Element in no Namespace. Parameters: name  String name of element. Reimplemented in DefaultJDOMFactory.

EntityRef JDOMFactory::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. name  String public ID of element. name  String system ID of element. Reimplemented in DefaultJDOMFactory.

EntityRef JDOMFactory::entityRef (  String    name )

This will create a new EntityRef with the supplied name. Parameters: name  String name of element. Reimplemented in DefaultJDOMFactory.

ProcessingInstruction JDOMFactory::processingInstruction (  String    target, String    data )

This will create a new ProcessingInstruction with the specified target and data. Parameters: target  String target of PI. rawData  String data for PI. Reimplemented in DefaultJDOMFactory.

ProcessingInstruction JDOMFactory::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 Reimplemented in DefaultJDOMFactory.

Text JDOMFactory::text (  String    text )

This creates the Text with the supplied text. Parameters: data  String content of Text. Reimplemented in DefaultJDOMFactory.

---

The documentation for this interface was generated from the following file:

• JDOMFactory.java

---