org::jdom::JDOMFactory Interface Reference

Inheritance diagram for org::jdom::JDOMFactory:

List of all members.

Public Member Functions
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, DocType docType, String baseURI)
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)
EntityRef	entityRef (String name, String systemID)
void	addContent (Parent parent, Content content)
void	setAttribute (Element element, Attribute a)
void	addNamespaceDeclaration (Element element, Namespace additional)

---

Detailed Description

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

---

Member Function Documentation

Attribute org::jdom::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 org.jdom.Namespace. Note: This actually explicitly puts the Attribute in the "empty" Namespace (org.jdom.Namespace#NO_NAMESPACE). Parameters: name  String name of Attribute. value  String value for new attribute. type  int type for new attribute. Implemented in org::jdom::DefaultJDOMFactory, and org::jdom::UncheckedJDOMFactory.

Attribute org::jdom::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 org.jdom.Namespace. Note: This actually explicitly puts the Attribute in the "empty" Namespace (org.jdom.Namespace#NO_NAMESPACE). Parameters: name  String name of Attribute. value  String value for new attribute. Implemented in org::jdom::DefaultJDOMFactory, and org::jdom::UncheckedJDOMFactory.

Attribute org::jdom::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 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. Implemented in org::jdom::DefaultJDOMFactory, and org::jdom::UncheckedJDOMFactory.

Attribute org::jdom::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 org.jdom.Namespace. Parameters: name  String name of Attribute. value  String value for new attribute. Implemented in org::jdom::DefaultJDOMFactory, and org::jdom::UncheckedJDOMFactory.

CDATA org::jdom::JDOMFactory::cdata (  String  str  )

This creates the CDATA with the supplied text. Parameters: str  String content of CDATA. Implemented in org::jdom::DefaultJDOMFactory, and org::jdom::UncheckedJDOMFactory.

Comment org::jdom::JDOMFactory::comment (  String  text  )

This creates the comment with the supplied text. Parameters: text  String content of comment. Implemented in org::jdom::DefaultJDOMFactory, and org::jdom::UncheckedJDOMFactory.

DocType org::jdom::JDOMFactory::docType (  String  elementName  )

This will create the DocType with the specified element name Parameters: elementName  String name of element being constrained. Implemented in org::jdom::DefaultJDOMFactory, and org::jdom::UncheckedJDOMFactory.

DocType org::jdom::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 Implemented in org::jdom::DefaultJDOMFactory, and org::jdom::UncheckedJDOMFactory.

DocType org::jdom::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 Implemented in org::jdom::DefaultJDOMFactory, and org::jdom::UncheckedJDOMFactory.

Document org::jdom::JDOMFactory::document (  Element  rootElement  )

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

Document org::jdom::JDOMFactory::document (  Element  rootElement, DocType  docType, String  baseURI )

This will create a new Document, with the supplied org.jdom.Element as the root element and the supplied org.jdom.DocType declaration. Parameters: rootElement  Element for document root. docType  DocType declaration. baseURI  the URI from which this doucment was loaded. Implemented in org::jdom::DefaultJDOMFactory, and org::jdom::UncheckedJDOMFactory.

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

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

Element org::jdom::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 org.jdom.Namespace the Element should be in. Parameters: name  String name of element. uri  String URI for Namespace element should be in. Implemented in org::jdom::DefaultJDOMFactory, and org::jdom::UncheckedJDOMFactory.

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

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

Element org::jdom::JDOMFactory::element (  String  name  )

This will create an Element in no org.jdom.Namespace. Parameters: name  String name of element. Implemented in org::jdom::DefaultJDOMFactory, and org::jdom::UncheckedJDOMFactory.

Element org::jdom::JDOMFactory::element (  String  name, Namespace  namespace )

This will create a new Element with the supplied (local) name, and define the org.jdom.Namespace to be used. Parameters: name  String name of element. namespace  Namespace to put element in. Implemented in org::jdom::DefaultJDOMFactory, and org::jdom::UncheckedJDOMFactory.

EntityRef org::jdom::JDOMFactory::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. Implemented in org::jdom::DefaultJDOMFactory, and org::jdom::UncheckedJDOMFactory.

EntityRef org::jdom::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. publicID  String public ID of element. systemID  String system ID of element. Implemented in org::jdom::DefaultJDOMFactory, and org::jdom::UncheckedJDOMFactory.

EntityRef org::jdom::JDOMFactory::entityRef (  String  name  )

This will create a new EntityRef with the supplied name. Parameters: name  String name of element. Implemented in org::jdom::DefaultJDOMFactory, and org::jdom::UncheckedJDOMFactory.

ProcessingInstruction org::jdom::JDOMFactory::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. Implemented in org::jdom::DefaultJDOMFactory, and org::jdom::UncheckedJDOMFactory.

ProcessingInstruction org::jdom::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 Implemented in org::jdom::DefaultJDOMFactory, and org::jdom::UncheckedJDOMFactory.

Text org::jdom::JDOMFactory::text (  String  str  )

This creates the Text with the supplied text. Parameters: str  String content of Text. Implemented in org::jdom::DefaultJDOMFactory, and org::jdom::UncheckedJDOMFactory.

---

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

• src/java/org/jdom/JDOMFactory.java

---