com.sun.xml.fastinfoset.stax.factory

Class StAXEventFactory

java.lang.Object

javax.xml.stream.XMLEventFactory

com.sun.xml.fastinfoset.stax.factory.StAXEventFactory

public class StAXEventFactory
extends XMLEventFactory

Constructor Summary

Constructors

Constructor and Description
StAXEventFactory() Creates a new instance of StAXEventFactory

Method Summary

Modifier and Type	Method and Description
Attribute	createAttribute(QName name, String value)
Attribute	createAttribute(String localName, String value) Create a new Attribute
Attribute	createAttribute(String prefix, String namespaceURI, String localName, String value) Create a new Attribute
Characters	createCData(String content) Create a Characters event with the CData flag set to true
Characters	createCharacters(String content) Create a Characters event, this method does not check if the content is all whitespace.
Comment	createComment(String text) Create a comment
DTD	createDTD(String dtd) Create a document type definition event This string contains the entire document type declaration that matches the doctypedecl in the XML 1.0 specification
EndDocument	createEndDocument()
EndElement	createEndElement(QName name, Iterator namespaces) Create a new EndElement
EndElement	createEndElement(String prefix, String namespaceUri, String localName) Create a new EndElement
EndElement	createEndElement(String prefix, String namespaceUri, String localName, Iterator namespaces) Create a new EndElement
EntityReference	createEntityReference(String name, EntityDeclaration entityDeclaration) Creates a new instance of a EntityReference event
Characters	createIgnorableSpace(String content) Create an ignorable space
Namespace	createNamespace(String namespaceURI) Create a new default Namespace
Namespace	createNamespace(String prefix, String namespaceURI) Create a new Namespace
ProcessingInstruction	createProcessingInstruction(String target, String data) Create a processing instruction
Characters	createSpace(String content) Create a Characters event with the isSpace flag set to true
StartDocument	createStartDocument() Creates a new instance of a StartDocument event
StartDocument	createStartDocument(String encoding) Creates a new instance of a StartDocument event
StartDocument	createStartDocument(String encoding, String version) Creates a new instance of a StartDocument event
StartDocument	createStartDocument(String encoding, String version, boolean standalone) Creates a new instance of a StartDocument event
StartElement	createStartElement(QName name, Iterator attributes, Iterator namespaces) Create a new StartElement.
StartElement	createStartElement(String prefix, String namespaceUri, String localName)
StartElement	createStartElement(String prefix, String namespaceUri, String localName, Iterator attributes, Iterator namespaces)
StartElement	createStartElement(String prefix, String namespaceUri, String localName, Iterator attributes, Iterator namespaces, NamespaceContext context)
void	setLocation(Location location) This method allows setting of the Location on each event that is created by this factory.

Methods inherited from class javax.xml.stream.XMLEventFactory

newFactory, newFactory, newInstance, newInstance

Methods inherited from class java.lang.Object

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

Constructor Detail

StAXEventFactory

public StAXEventFactory()

Creates a new instance of StAXEventFactory

Method Detail

setLocation

public void setLocation(Location location)

This method allows setting of the Location on each event that is created by this factory. The values are copied by value into the events created by this factory. To reset the location information set the location to null.

Specified by:

setLocation in class XMLEventFactory

Parameters:

location - the location to set on each event created

createAttribute

public Attribute createAttribute(String prefix,
                                 String namespaceURI,
                                 String localName,
                                 String value)

Create a new Attribute

Specified by:

createAttribute in class XMLEventFactory

Parameters:

prefix - the prefix of this attribute, may not be null

namespaceURI - the attribute value is set to this value, may not be null

localName - the local name of the XML name of the attribute, localName cannot be null

value - the attribute value to set, may not be null

Returns:

the Attribute with specified values

createAttribute

public Attribute createAttribute(String localName,
                                 String value)

Create a new Attribute

Specified by:

createAttribute in class XMLEventFactory

Parameters:

localName - the local name of the XML name of the attribute, localName cannot be null

value - the attribute value to set, may not be null

Returns:

the Attribute with specified values

createAttribute

public Attribute createAttribute(QName name,
                                 String value)

Specified by:

createAttribute in class XMLEventFactory

createNamespace

public Namespace createNamespace(String namespaceURI)

Create a new default Namespace

Specified by:

createNamespace in class XMLEventFactory

Parameters:

namespaceURI - the default namespace uri

Returns:

the Namespace with the specified value

createNamespace

public Namespace createNamespace(String prefix,
                                 String namespaceURI)

Create a new Namespace

Specified by:

createNamespace in class XMLEventFactory

Parameters:

prefix - the prefix of this namespace, may not be null

namespaceURI - the attribute value is set to this value, may not be null

Returns:

the Namespace with the specified values

createStartElement

public StartElement createStartElement(QName name,
                                       Iterator attributes,
                                       Iterator namespaces)

Create a new StartElement.

Specified by:

createStartElement in class XMLEventFactory

Parameters:

name - the qualified name of the attribute, may not be null

attributes - an optional unordered set of objects that implement Attribute to add to the new StartElement, may be null

namespaces - an optional unordered set of objects that implement Namespace to add to the new StartElement, may be null

Returns:

an instance of the requested StartElement

createStartElement

public StartElement createStartElement(String prefix,
                                       String namespaceUri,
                                       String localName)

Specified by:

createStartElement in class XMLEventFactory

createStartElement

public StartElement createStartElement(String prefix,
                                       String namespaceUri,
                                       String localName,
                                       Iterator attributes,
                                       Iterator namespaces)

Specified by:

createStartElement in class XMLEventFactory

createStartElement

public StartElement createStartElement(String prefix,
                                       String namespaceUri,
                                       String localName,
                                       Iterator attributes,
                                       Iterator namespaces,
                                       NamespaceContext context)

Specified by:

createStartElement in class XMLEventFactory

createEndElement

public EndElement createEndElement(QName name,
                                   Iterator namespaces)

Create a new EndElement

Specified by:

createEndElement in class XMLEventFactory

Parameters:

name - the qualified name of the EndElement

namespaces - an optional unordered set of objects that implement Namespace that have gone out of scope, may be null

Returns:

an instance of the requested EndElement

createEndElement

public EndElement createEndElement(String prefix,
                                   String namespaceUri,
                                   String localName)

Create a new EndElement

Specified by:

createEndElement in class XMLEventFactory

Parameters:

namespaceUri - the uri of the QName of the new StartElement

localName - the local name of the QName of the new StartElement

prefix - the prefix of the QName of the new StartElement

Returns:

an instance of the requested EndElement

createEndElement

public EndElement createEndElement(String prefix,
                                   String namespaceUri,
                                   String localName,
                                   Iterator namespaces)

Create a new EndElement

Specified by:

createEndElement in class XMLEventFactory

Parameters:

namespaceUri - the uri of the QName of the new StartElement

localName - the local name of the QName of the new StartElement

prefix - the prefix of the QName of the new StartElement

namespaces - an unordered set of objects that implement Namespace that have gone out of scope, may be null

Returns:

an instance of the requested EndElement

createCharacters

public Characters createCharacters(String content)

Create a Characters event, this method does not check if the content is all whitespace. To create a space event use #createSpace(String)

Specified by:

createCharacters in class XMLEventFactory

Parameters:

content - the string to create

Returns:

a Characters event

createCData

public Characters createCData(String content)

Create a Characters event with the CData flag set to true

Specified by:

createCData in class XMLEventFactory

Parameters:

content - the string to create

Returns:

a Characters event

createSpace

public Characters createSpace(String content)

Create a Characters event with the isSpace flag set to true

Specified by:

createSpace in class XMLEventFactory

Parameters:

content - the content of the space to create

Returns:

a Characters event

createIgnorableSpace

public Characters createIgnorableSpace(String content)

Create an ignorable space

Specified by:

createIgnorableSpace in class XMLEventFactory

Parameters:

content - the space to create

Returns:

a Characters event

createStartDocument

public StartDocument createStartDocument()

Creates a new instance of a StartDocument event

Specified by:

createStartDocument in class XMLEventFactory

Returns:

a StartDocument event

createStartDocument

public StartDocument createStartDocument(String encoding)

Creates a new instance of a StartDocument event

Specified by:

createStartDocument in class XMLEventFactory

Parameters:

encoding - the encoding style

Returns:

a StartDocument event

createStartDocument

public StartDocument createStartDocument(String encoding,
                                         String version)

Creates a new instance of a StartDocument event

Specified by:

createStartDocument in class XMLEventFactory

Parameters:

encoding - the encoding style

version - the XML version

Returns:

a StartDocument event

createStartDocument

public StartDocument createStartDocument(String encoding,
                                         String version,
                                         boolean standalone)

Creates a new instance of a StartDocument event

Specified by:

createStartDocument in class XMLEventFactory

Parameters:

encoding - the encoding style

version - the XML version

standalone - the status of standalone may be set to "true" or "false"

Returns:

a StartDocument event

createEndDocument

public EndDocument createEndDocument()

Specified by:

createEndDocument in class XMLEventFactory

createEntityReference

public EntityReference createEntityReference(String name,
                                             EntityDeclaration entityDeclaration)

Creates a new instance of a EntityReference event

Specified by:

createEntityReference in class XMLEventFactory

Parameters:

name - The name of the reference

entityDeclaration - the declaration for the event

Returns:

an EntityReference event

createComment

public Comment createComment(String text)

Create a comment

Specified by:

createComment in class XMLEventFactory

Parameters:

text - The text of the comment a Comment event

createDTD

public DTD createDTD(String dtd)

Create a document type definition event This string contains the entire document type declaration that matches the doctypedecl in the XML 1.0 specification

Specified by:

createDTD in class XMLEventFactory

Parameters:

dtd - the text of the document type definition

Returns:

a DTD event

createProcessingInstruction

public ProcessingInstruction createProcessingInstruction(String target,
                                                         String data)

Create a processing instruction

Specified by:

createProcessingInstruction in class XMLEventFactory

Parameters:

target - The target of the processing instruction

data - The text of the processing instruction

Returns:

a ProcessingInstruction event