javax.xml.stream

Class XMLEventFactory

java.lang.Object

javax.xml.stream.XMLEventFactory

public abstract class XMLEventFactory
extends java.lang.Object

Factory for XML events.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	XMLEventFactory()

Method Summary

Methods

Modifier and Type	Method and Description
abstract javax.xml.stream.events.Attribute	createAttribute(javax.xml.namespace.QName name, java.lang.String value) Create an attribute event.
abstract javax.xml.stream.events.Attribute	createAttribute(java.lang.String localName, java.lang.String value) Create an attribute event.
abstract javax.xml.stream.events.Attribute	createAttribute(java.lang.String prefix, java.lang.String namespaceURI, java.lang.String localName, java.lang.String value) Create an attribute event.
abstract javax.xml.stream.events.Characters	createCData(java.lang.String content) Create a text event of type CDATA section.
abstract javax.xml.stream.events.Characters	createCharacters(java.lang.String content) Create a text event.
abstract javax.xml.stream.events.Comment	createComment(java.lang.String text) Create a comment event.
abstract javax.xml.stream.events.DTD	createDTD(java.lang.String dtd) Create a DOCTYPE declaration event.
abstract javax.xml.stream.events.EndDocument	createEndDocument() Create an end-document event.
abstract javax.xml.stream.events.EndElement	createEndElement(javax.xml.namespace.QName name, java.util.Iterator namespaces) Create an end-element event.
abstract javax.xml.stream.events.EndElement	createEndElement(java.lang.String prefix, java.lang.String namespaceUri, java.lang.String localName) Create an end-element event.
abstract javax.xml.stream.events.EndElement	createEndElement(java.lang.String prefix, java.lang.String namespaceUri, java.lang.String localName, java.util.Iterator namespaces) Create an end-element event.
abstract javax.xml.stream.events.EntityReference	createEntityReference(java.lang.String name, javax.xml.stream.events.EntityDeclaration declaration) Create an entity reference event.
abstract javax.xml.stream.events.Characters	createIgnorableSpace(java.lang.String content) Create a text event of type ignorable whitespace.
abstract javax.xml.stream.events.Namespace	createNamespace(java.lang.String namespaceURI) Create a namespace declaration event.
abstract javax.xml.stream.events.Namespace	createNamespace(java.lang.String prefix, java.lang.String namespaceUri) Create a namespace declaration event.
abstract javax.xml.stream.events.ProcessingInstruction	createProcessingInstruction(java.lang.String target, java.lang.String data) Create a processing instruction event.
abstract javax.xml.stream.events.Characters	createSpace(java.lang.String content) Create a text event of type whitespace.
abstract javax.xml.stream.events.StartDocument	createStartDocument() Create a start-document event.
abstract javax.xml.stream.events.StartDocument	createStartDocument(java.lang.String encoding) Create a start-document event.
abstract javax.xml.stream.events.StartDocument	createStartDocument(java.lang.String encoding, java.lang.String version) Create a start-document event.
abstract javax.xml.stream.events.StartDocument	createStartDocument(java.lang.String encoding, java.lang.String version, boolean standalone) Create a start-document event.
abstract javax.xml.stream.events.StartElement	createStartElement(javax.xml.namespace.QName name, java.util.Iterator attributes, java.util.Iterator namespaces) Create a start-element event.
abstract javax.xml.stream.events.StartElement	createStartElement(java.lang.String prefix, java.lang.String namespaceUri, java.lang.String localName) Create a start-element event.
abstract javax.xml.stream.events.StartElement	createStartElement(java.lang.String prefix, java.lang.String namespaceUri, java.lang.String localName, java.util.Iterator attributes, java.util.Iterator namespaces) Create a start-element event.
abstract javax.xml.stream.events.StartElement	createStartElement(java.lang.String prefix, java.lang.String namespaceUri, java.lang.String localName, java.util.Iterator attributes, java.util.Iterator namespaces, javax.xml.namespace.NamespaceContext context) Create a start-element event.
static XMLEventFactory	newInstance() Create a new factory instance.
static XMLEventFactory	newInstance(java.lang.String factoryId, java.lang.ClassLoader classLoader) Create a new factory instance.
abstract void	setLocation(Location location) Sets the location for each event created by this factory.

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLEventFactory

protected XMLEventFactory()

Method Detail

newInstance

public static XMLEventFactory newInstance()
                                   throws FactoryConfigurationError

Create a new factory instance.

Throws:

FactoryConfigurationError

See Also:

newInstance(String,ClassLoader)

newInstance

public static XMLEventFactory newInstance(java.lang.String factoryId,
                          java.lang.ClassLoader classLoader)
                                   throws FactoryConfigurationError

Create a new factory instance. The implementation class to load is the first found in the following locations:

1. the javax.xml.stream.XMLEventFactory system property
2. the above named property value in the $JAVA_HOME/lib/stax.properties file
3. the class name specified in the META-INF/services/javax.xml.stream.XMLEventFactory system resource
4. the default factory class

Parameters:

factoryId - name of the factory to find, same as a property name

classLoader - the class loader to use

Returns:

the factory implementation

Throws:

FactoryConfigurationError - if an instance of this factory cannot be loaded

setLocation

public abstract void setLocation(Location location)

Sets the location for each event created by this factory.

createAttribute

public abstract javax.xml.stream.events.Attribute createAttribute(java.lang.String prefix,
                                                java.lang.String namespaceURI,
                                                java.lang.String localName,
                                                java.lang.String value)

Create an attribute event.

createAttribute

public abstract javax.xml.stream.events.Attribute createAttribute(java.lang.String localName,
                                                java.lang.String value)

Create an attribute event.

createAttribute

public abstract javax.xml.stream.events.Attribute createAttribute(javax.xml.namespace.QName name,
                                                java.lang.String value)

Create an attribute event.

createNamespace

public abstract javax.xml.stream.events.Namespace createNamespace(java.lang.String namespaceURI)

Create a namespace declaration event.

createNamespace

public abstract javax.xml.stream.events.Namespace createNamespace(java.lang.String prefix,
                                                java.lang.String namespaceUri)

Create a namespace declaration event.

createStartElement

public abstract javax.xml.stream.events.StartElement createStartElement(javax.xml.namespace.QName name,
                                                      java.util.Iterator attributes,
                                                      java.util.Iterator namespaces)

Create a start-element event.

createStartElement

public abstract javax.xml.stream.events.StartElement createStartElement(java.lang.String prefix,
                                                      java.lang.String namespaceUri,
                                                      java.lang.String localName)

Create a start-element event.

createStartElement

public abstract javax.xml.stream.events.StartElement createStartElement(java.lang.String prefix,
                                                      java.lang.String namespaceUri,
                                                      java.lang.String localName,
                                                      java.util.Iterator attributes,
                                                      java.util.Iterator namespaces)

Create a start-element event.

createStartElement

public abstract javax.xml.stream.events.StartElement createStartElement(java.lang.String prefix,
                                                      java.lang.String namespaceUri,
                                                      java.lang.String localName,
                                                      java.util.Iterator attributes,
                                                      java.util.Iterator namespaces,
                                                      javax.xml.namespace.NamespaceContext context)

Create a start-element event.

createEndElement

public abstract javax.xml.stream.events.EndElement createEndElement(javax.xml.namespace.QName name,
                                                  java.util.Iterator namespaces)

Create an end-element event.

createEndElement

public abstract javax.xml.stream.events.EndElement createEndElement(java.lang.String prefix,
                                                  java.lang.String namespaceUri,
                                                  java.lang.String localName)

Create an end-element event.

createEndElement

public abstract javax.xml.stream.events.EndElement createEndElement(java.lang.String prefix,
                                                  java.lang.String namespaceUri,
                                                  java.lang.String localName,
                                                  java.util.Iterator namespaces)

Create an end-element event.

createCharacters

public abstract javax.xml.stream.events.Characters createCharacters(java.lang.String content)

Create a text event.

createCData

public abstract javax.xml.stream.events.Characters createCData(java.lang.String content)

Create a text event of type CDATA section.

createSpace

public abstract javax.xml.stream.events.Characters createSpace(java.lang.String content)

Create a text event of type whitespace.

createIgnorableSpace

public abstract javax.xml.stream.events.Characters createIgnorableSpace(java.lang.String content)

Create a text event of type ignorable whitespace.

createStartDocument

public abstract javax.xml.stream.events.StartDocument createStartDocument()

Create a start-document event.

createStartDocument

public abstract javax.xml.stream.events.StartDocument createStartDocument(java.lang.String encoding,
                                                        java.lang.String version,
                                                        boolean standalone)

Create a start-document event.

createStartDocument

public abstract javax.xml.stream.events.StartDocument createStartDocument(java.lang.String encoding,
                                                        java.lang.String version)

Create a start-document event.

createStartDocument

public abstract javax.xml.stream.events.StartDocument createStartDocument(java.lang.String encoding)

Create a start-document event.

createEndDocument

public abstract javax.xml.stream.events.EndDocument createEndDocument()

Create an end-document event.

createEntityReference

public abstract javax.xml.stream.events.EntityReference createEntityReference(java.lang.String name,
                                                            javax.xml.stream.events.EntityDeclaration declaration)

Create an entity reference event.

createComment

public abstract javax.xml.stream.events.Comment createComment(java.lang.String text)

Create a comment event.

createProcessingInstruction

public abstract javax.xml.stream.events.ProcessingInstruction createProcessingInstruction(java.lang.String target,
                                                                        java.lang.String data)

Create a processing instruction event.

createDTD

public abstract javax.xml.stream.events.DTD createDTD(java.lang.String dtd)

Create a DOCTYPE declaration event.