org.licas_xml.abs

Class XMLFactory

java.lang.Object

org.licas_xml.abs.XMLFactory

Direct Known Subclasses:

XMLFactoryImpl

public abstract class XMLFactory
extends java.lang.Object

This abstract class must be extended by any class wishing to create xml documents or elements returning abstract instances. This is a factory for creating and returning different kinds of node.

Author:

Kieran Greer

Field Summary

Fields

Modifier and Type	Field and Description
protected static XMLFactory	singleton The node factory instance

Constructor Summary

Constructors

Constructor and Description
XMLFactory()

Method Summary

Modifier and Type	Method and Description
abstract Attribute	createAttribute(java.lang.String name, java.lang.String value) Create an attribute with the specified name and value.
abstract Document	createDocument() Create an empty document.
abstract Element	createElement() Create an element with no name or value.
abstract Element	createElement(java.lang.String name) Create an element with the specified name.
abstract Element	createElement(java.lang.String name, java.lang.String value) Create an element with the specified name and value.
abstract Node	createNode() Create a node with no name or value.
abstract Node	createNode(java.lang.String name) Create a node with the specified name.
abstract XMLReader	createReader() Create an xml reader.
abstract XMLReader	createReader(java.io.InputStream inStream) Create an xml reader.
abstract XMLReader	createReader(java.lang.String publicID, java.lang.String systemID) Create an XML reader.
abstract XMLWriter	createWriter() Create an xml writer.
abstract XMLWriter	createWriter(java.io.OutputStream outStream) Create an xml writer.
static XMLFactory	getInstance() Get an instance of this XMLFactory class.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

singleton

protected static XMLFactory singleton

The node factory instance

Constructor Detail

XMLFactory

public XMLFactory()

Method Detail

getInstance

public static XMLFactory getInstance()

Get an instance of this XMLFactory class.

Returns:

this XMLFactory object.

createReader

public abstract XMLReader createReader()
                                throws java.lang.Exception

Create an xml reader.

Returns:

the newly created reader.

Throws:

java.lang.Exception - any error.

createReader

public abstract XMLReader createReader(java.io.InputStream inStream)
                                throws java.lang.Exception

Create an xml reader.

Parameters:

inStream - the input stream to create the reader from.

Returns:

the newly created reader.

Throws:

java.lang.Exception - any error.

createReader

public abstract XMLReader createReader(java.lang.String publicID,
                                       java.lang.String systemID)
                                throws java.lang.Exception

Create an XML reader.

Parameters:

publicID - the public ID which can be null.

systemID - the system ID which cannot be null.

Throws:

java.lang.Exception - any error.

createWriter

public abstract XMLWriter createWriter()
                                throws java.lang.Exception

Create an xml writer.

Returns:

the newly created writer.

Throws:

java.lang.Exception - any error.

createWriter

public abstract XMLWriter createWriter(java.io.OutputStream outStream)
                                throws java.lang.Exception

Create an xml writer.

Parameters:

outStream - the stream to write to.

Returns:

the newly created writer.

Throws:

java.lang.Exception - any error.

createDocument

public abstract Document createDocument()
                                 throws java.lang.Exception

Create an empty document.

Returns:

the newly created document.

Throws:

java.lang.Exception - any error.

createAttribute

public abstract Attribute createAttribute(java.lang.String name,
                                          java.lang.String value)

Create an attribute with the specified name and value.

Parameters:

name - the attribute name.

value - the attribute value.

Returns:

the newly created attribute.

createNode

public abstract Node createNode()

Create a node with no name or value.

Returns:

the newly created node.

createNode

public abstract Node createNode(java.lang.String name)

Create a node with the specified name.

Parameters:

name - the node name.

Returns:

the newly created node.

createElement

public abstract Element createElement()

Create an element with no name or value.

Returns:

the newly created element.

createElement

public abstract Element createElement(java.lang.String name)

Create an element with the specified name.

Parameters:

name - the element name.

Returns:

the newly created element.

createElement

public abstract Element createElement(java.lang.String name,
                                      java.lang.String value)

Create an element with the specified name and value.

Parameters:

name - the element name.

value - the element value.

Returns:

the newly created element.