org.jdom.input

Class DefaultJDOMFactory

Implemented Interfaces:
JDOMFactory

public class DefaultJDOMFactory
extends java.lang.Object
implements JDOMFactory

DefaultJDOMFactory creates the standard top-level JDOM classes (Element, Document, Comment, etc). A subclass of this factory might construct custom classes.

Version:
$Revision: 1.6 $, $Date: 2002/03/12 07:57:06 $

Authors:
Ken Rune Holland
Phil Nelson
Bradley S. Huffman

Constructor Summary

DefaultJDOMFactory()

Method Summary

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 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 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 Namespace.
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 Namespace.
CDATA
cdata(String text)
This creates the CDATA with the supplied text.
Comment
comment(String text)
This creates the comment with the supplied text.
DocType
docType(String elementName)
This will create the DocType with the specified element name
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, String publicID, 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.
Element
element(String name)
This will create an Element in no Namespace.
Element
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).
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 Namespace the Element should be in.
Element
element(String name, Namespace namespace)
This will create a new Element with the supplied (local) name, and define the Namespace to be used.
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.
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.
Text
text(String text)
This creates the Text with the supplied text.

Constructor Details

DefaultJDOMFactory

public DefaultJDOMFactory()

Method Details

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

Note: This actually explicitly puts the Attribute in the "empty" Namespace (Namespace.NO_NAMESPACE).

Specified by:
attribute in interface JDOMFactory

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

Note: This actually explicitly puts the Attribute in the "empty" Namespace (Namespace.NO_NAMESPACE).

Specified by:
attribute in interface JDOMFactory

Parameters:
name - String name of Attribute.
value - String value for new attribute.
type - int type 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 Namespace.
Specified by:
attribute in interface JDOMFactory

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,
                           Namespace namespace)
This will create a new Attribute with the specified (local) name and value, and in the provided Namespace.
Specified by:
attribute in interface JDOMFactory

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


cdata

public CDATA cdata(String text)
This creates the CDATA with the supplied text.
Specified by:
cdata in interface JDOMFactory

Parameters:


comment

public Comment comment(String text)
This creates the comment with the supplied text.
Specified by:
comment in interface JDOMFactory

Parameters:
text - String content of comment.


docType

public DocType docType(String elementName)
This will create the DocType with the specified element name
Specified by:
docType in interface JDOMFactory

Parameters:
elementName - String name of element being constrained.


docType

public DocType docType(String elementName,
                       String systemID)
This will create the DocType with the specified element name and reference to an external DTD.
Specified by:
docType in interface JDOMFactory

Parameters:
elementName - String name of element being constrained.
systemID - String system ID of referenced DTD


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.
Specified by:
docType in interface JDOMFactory

Parameters:
elementName - String name of element being constrained.
publicID - String public ID of referenced DTD
systemID - String system ID of referenced DTD


document

public Document document(Element rootElement)
This will create a new Document, with the supplied Element as the root element, and no DocType declaration.
Specified by:
document in interface JDOMFactory

Parameters:
rootElement - Element for document root


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.
Specified by:
document in interface JDOMFactory

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


element

public Element element(String name)
This will create an Element in no Namespace.
Specified by:
element in interface JDOMFactory

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 Namespace the Element should be in, resulting it being unprefixed (in the default namespace).
Specified by:
element in interface JDOMFactory

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 Namespace the Element should be in.
Specified by:
element in interface JDOMFactory

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


element

public Element element(String name,
                       Namespace namespace)
This will create a new Element with the supplied (local) name, and define the Namespace to be used.
Specified by:
element in interface JDOMFactory

Parameters:
name - String name of element.


entityRef

public EntityRef entityRef(String name)
This will create a new EntityRef with the supplied name.
Specified by:
entityRef in interface JDOMFactory

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.
Specified by:
entityRef in interface JDOMFactory

Parameters:
name - String name of element.


processingInstruction

public ProcessingInstruction processingInstruction(String target,
                                                   Map data)
This will create a new ProcessingInstruction with the specified target and data.
Specified by:
processingInstruction in interface JDOMFactory

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.
Specified by:
processingInstruction in interface JDOMFactory

Parameters:
target - String target of PI.


text

public Text text(String text)
This creates the Text with the supplied text.
Specified by:
text in interface JDOMFactory

Parameters:


Copyright B) 2002 Jason Hunter, Brett McLaughlin. All Rights Reserved.