javax.xml.stream

Class XMLEventFactory


public abstract class XMLEventFactory
extends Object

Factory for XML events.

Constructor Summary

XMLEventFactory()

Method Summary

abstract Attribute
createAttribute(String localName, String value)
Create an attribute event.
abstract Attribute
createAttribute(String prefix, String namespaceURI, String localName, String value)
Create an attribute event.
abstract Attribute
createAttribute(QName name, String value)
Create an attribute event.
abstract Characters
createCData(String content)
Create a text event of type CDATA section.
abstract Characters
createCharacters(String content)
Create a text event.
abstract Comment
createComment(String text)
Create a comment event.
abstract DTD
createDTD(String dtd)
Create a DOCTYPE declaration event.
abstract EndDocument
createEndDocument()
Create an end-document event.
abstract EndElement
createEndElement(String prefix, String namespaceUri, String localName)
Create an end-element event.
abstract EntityReference
createEntityReference(String name, EntityDeclaration declaration)
Create an entity reference event.
abstract Characters
createIgnorableSpace(String content)
Create a text event of type ignorable whitespace.
abstract Namespace
createNamespace(String namespaceURI)
Create a namespace declaration event.
abstract Namespace
createNamespace(String prefix, String namespaceUri)
Create a namespace declaration event.
abstract ProcessingInstruction
createProcessingInstruction(String target, String data)
Create a processing instruction event.
abstract Characters
createSpace(String content)
Create a text event of type whitespace.
abstract StartDocument
createStartDocument()
Create a start-document event.
abstract StartDocument
createStartDocument(String encoding)
Create a start-document event.
abstract StartDocument
createStartDocument(String encoding, String version)
Create a start-document event.
abstract StartDocument
createStartDocument(String encoding, String version, boolean standalone)
Create a start-document event.
abstract StartElement
createStartElement(String prefix, String namespaceUri, String localName)
Create a start-element event.
static XMLEventFactory
newInstance()
Create a new factory instance.
static XMLEventFactory
newInstance(String factoryId, 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, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

XMLEventFactory

protected XMLEventFactory()

Method Details

createAttribute

public abstract Attribute createAttribute(String localName,
                                          String value)
Create an attribute event.

createAttribute

public abstract Attribute createAttribute(String prefix,
                                          String namespaceURI,
                                          String localName,
                                          String value)
Create an attribute event.

createAttribute

public abstract Attribute createAttribute(QName name,
                                          String value)
Create an attribute event.

createCData

public abstract Characters createCData(String content)
Create a text event of type CDATA section.

createCharacters

public abstract Characters createCharacters(String content)
Create a text event.

createComment

public abstract Comment createComment(String text)
Create a comment event.

createDTD

public abstract DTD createDTD(String dtd)
Create a DOCTYPE declaration event.

createEndDocument

public abstract EndDocument createEndDocument()
Create an end-document event.

createEndElement

public abstract EndElement createEndElement(String prefix,
                                            String namespaceUri,
                                            String localName)
Create an end-element event.

createEntityReference

public abstract EntityReference createEntityReference(String name,
                                                      EntityDeclaration declaration)
Create an entity reference event.

createIgnorableSpace

public abstract Characters createIgnorableSpace(String content)
Create a text event of type ignorable whitespace.

createNamespace

public abstract Namespace createNamespace(String namespaceURI)
Create a namespace declaration event.

createNamespace

public abstract Namespace createNamespace(String prefix,
                                          String namespaceUri)
Create a namespace declaration event.

createProcessingInstruction

public abstract ProcessingInstruction createProcessingInstruction(String target,
                                                                  String data)
Create a processing instruction event.

createSpace

public abstract Characters createSpace(String content)
Create a text event of type whitespace.

createStartDocument

public abstract StartDocument createStartDocument()
Create a start-document event.

createStartDocument

public abstract StartDocument createStartDocument(String encoding)
Create a start-document event.

createStartDocument

public abstract StartDocument createStartDocument(String encoding,
                                                  String version)
Create a start-document event.

createStartDocument

public abstract StartDocument createStartDocument(String encoding,
                                                  String version,
                                                  boolean standalone)
Create a start-document event.

createStartElement

public abstract StartElement createStartElement(String prefix,
                                                String namespaceUri,
                                                String localName)
Create a start-element event.

newInstance

public static XMLEventFactory newInstance()
            throws FactoryConfigurationError
Create a new factory instance.

newInstance

public static XMLEventFactory newInstance(String factoryId,
                                          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.

XMLEventFactory.java -- Copyright (C) 2005,2006,2009 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.