org::jdom::input::DefaultJDOMFactory

org::jdom::input::DefaultJDOMFactory Class Reference

Inheritance diagram for org::jdom::input::DefaultJDOMFactory:

org::jdom::input::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 text)
Text text (String text)
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

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

Author:
Ken Rune Holland

Phil Nelson

Bradley S. Huffman

Version:
Revision
1.10
,
Date
2003/04/06 02:00:44

Member Function Documentation

Attribute org::jdom::input::DefaultJDOMFactory::attribute ( String  name,
String  value,
Namespace  namespace 
) [inline]

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.

Implements org::jdom::input::JDOMFactory.

Attribute org::jdom::input::DefaultJDOMFactory::attribute ( String  name,
String  value,
int  type,
Namespace  namespace 
) [inline]

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.

Implements org::jdom::input::JDOMFactory.

Attribute org::jdom::input::DefaultJDOMFactory::attribute ( String  name,
String  value 
) [inline]

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.

Implements org::jdom::input::JDOMFactory.

Attribute org::jdom::input::DefaultJDOMFactory::attribute ( String  name,
String  value,
int  type 
) [inline]

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.

Implements org::jdom::input::JDOMFactory.

CDATA org::jdom::input::DefaultJDOMFactory::cdata ( String  text  )  [inline]

This creates the CDATA with the supplied text.

Parameters:
str String content of CDATA.

Implements org::jdom::input::JDOMFactory.

Text org::jdom::input::DefaultJDOMFactory::text ( String  text  )  [inline]

This creates the Text with the supplied text.

Parameters:
str String content of Text.

Implements org::jdom::input::JDOMFactory.

Comment org::jdom::input::DefaultJDOMFactory::comment ( String  text  )  [inline]

This creates the comment with the supplied text.

Parameters:
text String content of comment.

Implements org::jdom::input::JDOMFactory.

DocType org::jdom::input::DefaultJDOMFactory::docType ( String  elementName,
String  publicID,
String  systemID 
) [inline]

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

Implements org::jdom::input::JDOMFactory.

DocType org::jdom::input::DefaultJDOMFactory::docType ( String  elementName,
String  systemID 
) [inline]

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

Implements org::jdom::input::JDOMFactory.

DocType org::jdom::input::DefaultJDOMFactory::docType ( String  elementName  )  [inline]

This will create the DocType with the specified element name

Parameters:
elementName String name of element being constrained.

Implements org::jdom::input::JDOMFactory.

Document org::jdom::input::DefaultJDOMFactory::document ( Element  rootElement,
DocType  docType 
) [inline]

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.

Implements org::jdom::input::JDOMFactory.

Document org::jdom::input::DefaultJDOMFactory::document ( Element  rootElement  )  [inline]

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

Parameters:
rootElement Element for document root

Implements org::jdom::input::JDOMFactory.

Element org::jdom::input::DefaultJDOMFactory::element ( String  name,
Namespace  namespace 
) [inline]

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

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

Implements org::jdom::input::JDOMFactory.

Element org::jdom::input::DefaultJDOMFactory::element ( String  name  )  [inline]

This will create an Element in no Namespace.

Parameters:
name String name of element.

Implements org::jdom::input::JDOMFactory.

Element org::jdom::input::DefaultJDOMFactory::element ( String  name,
String  uri 
) [inline]

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.

Implements org::jdom::input::JDOMFactory.

Element org::jdom::input::DefaultJDOMFactory::element ( String  name,
String  prefix,
String  uri 
) [inline]

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.

Implements org::jdom::input::JDOMFactory.

ProcessingInstruction org::jdom::input::DefaultJDOMFactory::processingInstruction ( String  target,
Map  data 
) [inline]

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

Implements org::jdom::input::JDOMFactory.

ProcessingInstruction org::jdom::input::DefaultJDOMFactory::processingInstruction ( String  target,
String  data 
) [inline]

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

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

Implements org::jdom::input::JDOMFactory.

EntityRef org::jdom::input::DefaultJDOMFactory::entityRef ( String  name  )  [inline]

This will create a new EntityRef with the supplied name.

Parameters:
name String name of element.

Implements org::jdom::input::JDOMFactory.

EntityRef org::jdom::input::DefaultJDOMFactory::entityRef ( String  name,
String  publicID,
String  systemID 
) [inline]

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.

Implements org::jdom::input::JDOMFactory.

The documentation for this class was generated from the following file:
Generated on Sun Nov 5 16:02:38 2006 for JDOM by  doxygen 1.5.1