XMLEventFactory (Java Platform SE 6)

This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.

Overview

Package

Class

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.xml.stream
class XMLEventFactory

java.lang.Object
  javax.xml.stream.XMLEventFactory

Most common way to construct:

XMLEventFactory eventFactory = XMLEventFactory.newInstance();

Based on 35 examples

public abstract class XMLEventFactory
extends Object

This interface defines a utility class for creating instances of XMLEvents

Constructor Summary
`protected`	`XMLEventFactory()`

Method Summary
`abstract Attribute`	`createAttribute(QName name, String value)` Create a new Attribute
`abstract Attribute`	`createAttribute(String localName, String value)` Create a new Attribute
`abstract Attribute`	`createAttribute(String prefix, String namespaceURI, String localName, String value)` Create a new Attribute
`abstract Characters`	`createCData(String content)` Create a Characters event with the CData flag set to true
`abstract Characters`	`createCharacters(String content)` Create a Characters event, this method does not check if the content is all whitespace.
`abstract Comment`	`createComment(String text)` Create a comment
`abstract 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
`abstract EndDocument`	`createEndDocument()` Creates a new instance of an EndDocument event
`abstract EndElement`	`createEndElement(QName name, Iterator namespaces)` Create a new EndElement
`abstract EndElement`	`createEndElement(String prefix, String namespaceUri, String localName)` Create a new EndElement
`abstract EndElement`	`createEndElement(String prefix, String namespaceUri, String localName, Iterator namespaces)` Create a new EndElement
`abstract EntityReference`	`createEntityReference(String name, EntityDeclaration declaration)` Creates a new instance of a EntityReference event
`abstract Characters`	`createIgnorableSpace(String content)` Create an ignorable space
`abstract Namespace`	`createNamespace(String namespaceURI)` Create a new default Namespace
`abstract Namespace`	`createNamespace(String prefix, String namespaceUri)` Create a new Namespace
`abstract ProcessingInstruction`	`createProcessingInstruction(String target, String data)` Create a processing instruction
`abstract Characters`	`createSpace(String content)` Create a Characters event with the isSpace flag set to true
`abstract StartDocument`	`createStartDocument()` Creates a new instance of a StartDocument event
`abstract StartDocument`	`createStartDocument(String encoding)` Creates a new instance of a StartDocument event
`abstract StartDocument`	`createStartDocument(String encoding, String version)` Creates a new instance of a StartDocument event
`abstract StartDocument`	`createStartDocument(String encoding, String version, boolean standalone)` Creates a new instance of a StartDocument event
`abstract StartElement`	`createStartElement(QName name, Iterator attributes, Iterator namespaces)` Create a new StartElement.
`abstract StartElement`	`createStartElement(String prefix, String namespaceUri, String localName)` Create a new StartElement.
`abstract StartElement`	`createStartElement(String prefix, String namespaceUri, String localName, Iterator attributes, Iterator namespaces)` Create a new StartElement.
`abstract StartElement`	`createStartElement(String prefix, String namespaceUri, String localName, Iterator attributes, Iterator namespaces, NamespaceContext context)` Create a new StartElement.
`static XMLEventFactory`	`newInstance()` Create a new instance of the factory
`static XMLEventFactory`	`newInstance(String factoryId, ClassLoader classLoader)` Create a new instance of the factory
`abstract void`	`setLocation(Location location)` This method allows setting of the Location on each event that is 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

createAttribute

public abstract Attribute createAttribute(QName name,
                                          String value)

Create a new Attribute

Parameters:: name - the qualified name of the attribute, may not be null; value - the attribute value to set, may not be null
Returns:: the Attribute with specified values

createAttribute

public abstract Attribute createAttribute(String localName,
                                          String value)

Create a new Attribute

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 abstract Attribute createAttribute(String prefix,
                                          String namespaceURI,
                                          String localName,
                                          String value)

Create a new Attribute

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

createCData

public abstract Characters createCData(String content)

Create a Characters event with the CData flag set to true

Parameters:: content - the string to create
Returns:: a Characters event

createCharacters

public abstract 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)

Parameters:: content - the string to create
Returns:: a Characters event

createComment

public abstract Comment createComment(String text)

Create a comment

Parameters:: text - The text of the comment a Comment event

createDTD

public abstract 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

Parameters:: dtd - the text of the document type definition
Returns:: a DTD event

createEndDocument

public abstract EndDocument createEndDocument()

Creates a new instance of an EndDocument event

Returns:: an EndDocument event

createEndElement

public abstract EndElement createEndElement(QName name,
                                            Iterator namespaces)

Create a new EndElement

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 abstract EndElement createEndElement(String prefix,
                                            String namespaceUri,
                                            String localName)

Create a new EndElement

Parameters:: prefix - the prefix of the QName of the new StartElement; namespaceUri - the uri of the QName of the new StartElement; localName - the local name of the QName of the new StartElement
Returns:: an instance of the requested EndElement

createEndElement

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

Create a new EndElement

Parameters:: prefix - the prefix of the QName of the new StartElement; namespaceUri - the uri of the QName of the new StartElement; localName - the local name 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

createEntityReference

public abstract EntityReference createEntityReference(String name,
                                                      EntityDeclaration declaration)

Creates a new instance of a EntityReference event

Parameters:: name - The name of the reference; declaration - the declaration for the event
Returns:: an EntityReference event

createIgnorableSpace

public abstract Characters createIgnorableSpace(String content)

Create an ignorable space

Parameters:: content - the space to create
Returns:: a Characters event

createNamespace

public abstract Namespace createNamespace(String namespaceURI)

Create a new default Namespace

Parameters:: namespaceURI - the default namespace uri
Returns:: the Namespace with the specified value

createNamespace

public abstract Namespace createNamespace(String prefix,
                                          String namespaceUri)

Create a new Namespace

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

createProcessingInstruction

public abstract ProcessingInstruction createProcessingInstruction(String target,
                                                                  String data)

Create a processing instruction

Parameters:: target - The target of the processing instruction; data - The text of the processing instruction
Returns:: a ProcessingInstruction event

createSpace

public abstract Characters createSpace(String content)

Create a Characters event with the isSpace flag set to true

Parameters:: content - the content of the space to create
Returns:: a Characters event

createStartDocument

public abstract StartDocument createStartDocument()

Creates a new instance of a StartDocument event

Returns:: a StartDocument event

createStartDocument

public abstract StartDocument createStartDocument(String encoding)

Creates a new instance of a StartDocument event

Parameters:: encoding - the encoding style
Returns:: a StartDocument event

createStartDocument

public abstract StartDocument createStartDocument(String encoding,
                                                  String version)

Creates a new instance of a StartDocument event

Parameters:: encoding - the encoding style; version - the XML version
Returns:: a StartDocument event

createStartDocument

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

Creates a new instance of a StartDocument event

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

createStartElement

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

Create a new StartElement. Namespaces can be added to this StartElement by passing in an Iterator that walks over a set of Namespace interfaces. Attributes can be added to this StartElement by passing an iterator that walks over a set of Attribute interfaces.

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 abstract StartElement createStartElement(String prefix,
                                                String namespaceUri,
                                                String localName)

Create a new StartElement. This defaults the NamespaceContext to an empty NamespaceContext. Querying this event for its namespaces or attributes will result in an empty iterator being returned.

Parameters:: prefix - the prefix of the QName of the new StartElement; namespaceUri - the uri of the QName of the new StartElement; localName - the local name of the QName of the new StartElement
Returns:: an instance of the requested StartElement

createStartElement

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

Parameters:: prefix - the prefix of the QName of the new StartElement; namespaceUri - the uri of the QName of the new StartElement; localName - the local name of the QName of the new StartElement; attributes - an unordered set of objects that implement Attribute to add to the new StartElement; namespaces - an unordered set of objects that implement Namespace to add to the new StartElement
Returns:: an instance of the requested StartElement

createStartElement

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

Parameters:: prefix - the prefix of the QName of the new StartElement; namespaceUri - the uri of the QName of the new StartElement; localName - the local name of the QName of the new StartElement; attributes - an unordered set of objects that implement Attribute to add to the new StartElement, may be null; namespaces - an unordered set of objects that implement Namespace to add to the new StartElement, may be null; context - the namespace context of this element
Returns:: an instance of the requested StartElement

newInstance

public static XMLEventFactory newInstance()
                                   throws FactoryConfigurationError

Create a new instance of the factory

Throws:: FactoryConfigurationError - if an instance of this factory cannot be loaded

newInstance

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

Create a new instance of the factory

Parameters:: factoryId - Name of the factory to find, same as a property name; classLoader - classLoader to use
Returns:: the factory implementation
Throws:: FactoryConfigurationError - if an instance of this factory cannot be loaded

setLocation

public abstract 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.

Parameters:: location - the location to set on each event created

Overview

Package

Class

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:

The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.

javax.xml.streamclass XMLEventFactory

XMLEventFactory

createAttribute

createAttribute

createAttribute

createCData

createCharacters

createComment

createDTD

createEndDocument

createEndElement

createEndElement

createEndElement

createEntityReference

createIgnorableSpace

createNamespace

createNamespace

createProcessingInstruction

createSpace

createStartDocument

createStartDocument

createStartDocument

createStartDocument

createStartElement

createStartElement

createStartElement

createStartElement

newInstance

newInstance

setLocation

javax.xml.stream
class XMLEventFactory