Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> [ jdom overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.jdom
Interface JDOMFactory  

All Known Implementing Classes:

DefaultJDOMFactory, UncheckedJDOMFactory

---

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 $

---

Method Summary
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 new Attribute 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 new Attribute 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 new Attribute 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 new Attribute 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 the DocType with the specified element name
DocType	docType(java.lang.String elementName, java.lang.String systemID)           This will create the DocType 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 the DocType with the specified element name and a reference to an external DTD.
Document	document(Element rootElement)           This will create a new Document, with the supplied Element as the root element, and no DocType declaration.
Document	document(Element rootElement, DocType docType)           This will create a new Document, with the supplied Element as the root element and the supplied DocType declaration.
Document	document(Element rootElement, DocType docType, java.lang.String baseURI)           This will create a new Document, with the supplied Element as the root element and the supplied DocType declaration.
Element	element(java.lang.String name)           This will create an Element in no Namespace.
Element	element(java.lang.String name, Namespace namespace)           This will create a new Element with the supplied (local) name, and define the Namespace to be used.
Element	element(java.lang.String name, java.lang.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).
Element	element(java.lang.String name, java.lang.String prefix, java.lang.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.
EntityRef	entityRef(java.lang.String name)           This will create a new EntityRef with the supplied name.
EntityRef	entityRef(java.lang.String name, java.lang.String systemID)           This will create a new EntityRef 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 new EntityRef with the supplied name, public ID, and system ID.
ProcessingInstruction	processingInstruction(java.lang.String target, java.util.Map data)           This will create a new ProcessingInstruction with the specified target and data.
ProcessingInstruction	processingInstruction(java.lang.String target, java.lang.String data)           This will create a new ProcessingInstruction 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

public 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.

---

attribute

public Attribute attribute(java.lang.String name,
                           java.lang.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.

---

attribute

public Attribute attribute(java.lang.String name,
                           java.lang.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 55 ).

---

attribute

public Attribute attribute(java.lang.String name,
                           java.lang.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 55 ).

---

cdata

public CDATA cdata(java.lang.String str)

This creates the CDATA with the supplied text.

---

text

public Text text(java.lang.String str)

This creates the Text with the supplied text.

---

comment

public Comment comment(java.lang.String text)

This creates the comment with the supplied text.

---

docType

public DocType docType(java.lang.String elementName,
                       java.lang.String publicID,
                       java.lang.String systemID)

This will create the DocType with the specified element name and a reference to an external DTD.

---

docType

public DocType docType(java.lang.String elementName,
                       java.lang.String systemID)

This will create the DocType with the specified element name and reference to an external DTD.

---

docType

public DocType docType(java.lang.String elementName)

This will create the DocType with the specified element name

---

document

public Document document(Element rootElement,
                         DocType docType)

This will create a new Document, with the supplied Element as the root element and the supplied DocType declaration.

---

document

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

This will create a new Document, with the supplied Element as the root element and the supplied DocType declaration.

---

document

public Document document(Element rootElement)

This will create a new Document, with the supplied Element as the root element, and no DocType declaration.

---

element

public Element element(java.lang.String name,
                       Namespace namespace)

This will create a new Element with the supplied (local) name, and define the Namespace to be used.

---

element

public Element element(java.lang.String name)

This will create an Element in no Namespace.

---

element

public Element element(java.lang.String name,
                       java.lang.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).

---

element

public Element element(java.lang.String name,
                       java.lang.String prefix,
                       java.lang.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.

---

processingInstruction

public ProcessingInstruction processingInstruction(java.lang.String target,
                                                   java.util.Map data)

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

---

processingInstruction

public ProcessingInstruction processingInstruction(java.lang.String target,
                                                   java.lang.String data)

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

---

entityRef

public EntityRef entityRef(java.lang.String name)

This will create a new EntityRef with the supplied name.

---

entityRef

public EntityRef entityRef(java.lang.String name,
                           java.lang.String publicID,
                           java.lang.String systemID)

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

---

entityRef

public EntityRef entityRef(java.lang.String name,
                           java.lang.String systemID)

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

---

addContent

public void addContent(Parent parent,
                       Content content)

---

setAttribute

public void setAttribute(Element element,
                         Attribute a)

---

addNamespaceDeclaration

public void addNamespaceDeclaration(Element element,
                                    Namespace additional)

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> [ jdom overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---