- java.lang.Object
-
- javax.xml.stream.XMLEventFactory
-
public abstract class XMLEventFactory extends Object
This interface defines a utility class for creating instances of XMLEvents- Since:
- 1.6
- See Also:
StartElement,EndElement,ProcessingInstruction,Comment,Characters,StartDocument,EndDocument,DTD
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedXMLEventFactory()
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods Modifier and Type Method Description abstract AttributecreateAttribute(String localName, String value)Create a new Attributeabstract AttributecreateAttribute(String prefix, String namespaceURI, String localName, String value)Create a new Attributeabstract AttributecreateAttribute(QName name, String value)Create a new Attributeabstract CharacterscreateCData(String content)Create a Characters event with the CData flag set to trueabstract CharacterscreateCharacters(String content)Create a Characters event, this method does not check if the content is all whitespace.abstract CommentcreateComment(String text)Create a commentabstract DTDcreateDTD(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 specificationabstract EndDocumentcreateEndDocument()Creates a new instance of an EndDocument eventabstract EndElementcreateEndElement(String prefix, String namespaceUri, String localName)Create a new EndElementabstract EndElementcreateEndElement(String prefix, String namespaceUri, String localName, Iterator<? extends Namespace> namespaces)Create a new EndElementabstract EndElementcreateEndElement(QName name, Iterator<? extends Namespace> namespaces)Create a new EndElementabstract EntityReferencecreateEntityReference(String name, EntityDeclaration declaration)Creates a new instance of a EntityReference eventabstract CharacterscreateIgnorableSpace(String content)Create an ignorable spaceabstract NamespacecreateNamespace(String namespaceURI)Create a new default Namespaceabstract NamespacecreateNamespace(String prefix, String namespaceUri)Create a new Namespaceabstract ProcessingInstructioncreateProcessingInstruction(String target, String data)Create a processing instructionabstract CharacterscreateSpace(String content)Create a Characters event with the isSpace flag set to trueabstract StartDocumentcreateStartDocument()Creates a new instance of a StartDocument eventabstract StartDocumentcreateStartDocument(String encoding)Creates a new instance of a StartDocument eventabstract StartDocumentcreateStartDocument(String encoding, String version)Creates a new instance of a StartDocument eventabstract StartDocumentcreateStartDocument(String encoding, String version, boolean standalone)Creates a new instance of a StartDocument eventabstract StartElementcreateStartElement(String prefix, String namespaceUri, String localName)Create a new StartElement.abstract StartElementcreateStartElement(String prefix, String namespaceUri, String localName, Iterator<? extends Attribute> attributes, Iterator<? extends Namespace> namespaces)Create a new StartElement.abstract StartElementcreateStartElement(String prefix, String namespaceUri, String localName, Iterator<? extends Attribute> attributes, Iterator<? extends Namespace> namespaces, NamespaceContext context)Create a new StartElement.abstract StartElementcreateStartElement(QName name, Iterator<? extends Attribute> attributes, Iterator<? extends Namespace> namespaces)Create a new StartElement.static XMLEventFactorynewDefaultFactory()Creates a new instance of theXMLEventFactorybuiltin system-default implementation.static XMLEventFactorynewFactory()Create a new instance of the factory.static XMLEventFactorynewFactory(String factoryId, ClassLoader classLoader)Create a new instance of the factory.static XMLEventFactorynewInstance()Creates a new instance of the factory in exactly the same manner as thenewFactory()method.static XMLEventFactorynewInstance(String factoryId, ClassLoader classLoader)Deprecated.This method has been deprecated to maintain API consistency.abstract voidsetLocation(Location location)This method allows setting of the Location on each event that is created by this factory.
-
-
-
Method Detail
-
newDefaultFactory
public static XMLEventFactory newDefaultFactory()
Creates a new instance of theXMLEventFactorybuiltin system-default implementation.- Returns:
- A new instance of the
XMLEventFactorybuiltin system-default implementation. - Since:
- 9
-
newInstance
public static XMLEventFactory newInstance() throws FactoryConfigurationError
Creates a new instance of the factory in exactly the same manner as thenewFactory()method.- Throws:
FactoryConfigurationError- if an instance of this factory cannot be loaded
-
newFactory
public static XMLEventFactory newFactory() throws FactoryConfigurationError
Create a new instance of the factory.This static method creates a new factory instance. This method uses the following ordered lookup procedure to determine the XMLEventFactory implementation class to load:
- Use the javax.xml.stream.XMLEventFactory system property.
-
Use the configuration file "stax.properties". The file is in standard
Propertiesformat and typically located in theconfdirectory of the Java installation. It contains the fully qualified name of the implementation class with the key being the system property defined above.The stax.properties file is read only once by the implementation and its values are then cached for future use. If the file does not exist when the first attempt is made to read from it, no further attempts are made to check for its existence. It is not possible to change the value of any property in stax.properties after it has been read for the first time.
Use the jaxp configuration file "jaxp.properties". The file is in the same format as stax.properties and will only be read if stax.properties does not exist.
-
Use the service-provider loading facility, defined by the
ServiceLoaderclass, to attempt to locate and load an implementation of the service using the default loading mechanism: the service-provider loading facility will use the current thread's context class loader to attempt to load the service. If the context class loader is null, the system class loader will be used. -
Otherwise, the system-default implementation is returned.
Once an application has obtained a reference to a XMLEventFactory it can use the factory to configure and obtain stream instances.
- Throws:
FactoryConfigurationError- in case of service configuration error or if the implementation is not available or cannot be instantiated.
-
newInstance
@Deprecated(since="1.7") public static XMLEventFactory newInstance(String factoryId, ClassLoader classLoader) throws FactoryConfigurationError
Deprecated.This method has been deprecated to maintain API consistency. All newInstance methods have been replaced with corresponding newFactory methods. The replacementnewFactory(java.lang.String, java.lang.ClassLoader)method defines no changes in behavior.Create a new instance of the factory- Parameters:
factoryId- Name of the factory to find, same as a property nameclassLoader- classLoader to use- Returns:
- the factory implementation
- Throws:
FactoryConfigurationError- if an instance of this factory cannot be loaded
-
newFactory
public static XMLEventFactory newFactory(String factoryId, ClassLoader classLoader) throws FactoryConfigurationError
Create a new instance of the factory. If the classLoader argument is null, then the ContextClassLoader is used.This method uses the following ordered lookup procedure to determine the XMLEventFactory implementation class to load:
-
Use the value of the system property identified by
factoryId. -
Use the configuration file "stax.properties". The file is in standard
Propertiesformat and typically located in the conf directory of the Java installation. It contains the fully qualified name of the implementation class with the key being the system property defined above.The stax.properties file is read only once by the implementation and its values are then cached for future use. If the file does not exist when the first attempt is made to read from it, no further attempts are made to check for its existence. It is not possible to change the value of any property in stax.properties after it has been read for the first time.
Use the jaxp configuration file "jaxp.properties". The file is in the same format as stax.properties and will only be read if stax.properties does not exist.
-
If
factoryIdis "javax.xml.stream.XMLEventFactory", use the service-provider loading facility, defined by theServiceLoaderclass, to attempt to locate and load an implementation of the service using the specifiedClassLoader. IfclassLoaderis null, the default loading mechanism will apply: That is, the service-provider loading facility will use the current thread's context class loader to attempt to load the service. If the context class loader is null, the system class loader will be used. -
Otherwise, throws a
FactoryConfigurationError.
Note that this is a new method that replaces the deprecated
newInstance(String factoryId, ClassLoader classLoader)method. No changes in behavior are defined by this replacement method relative to the deprecated method.- API Note:
- The parameter factoryId defined here is inconsistent with that of other JAXP factories where the first parameter is fully qualified factory class name that provides implementation of the factory.
- Parameters:
factoryId- Name of the factory to find, same as a property nameclassLoader- classLoader to use- Returns:
- the factory implementation
- Throws:
FactoryConfigurationError- in case of service configuration error or if the implementation is not available or cannot be instantiated.
-
Use the value of the system property identified by
-
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
-
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 nullnamespaceURI- the attribute value is set to this value, may not be nulllocalName- the local name of the XML name of the attribute, localName cannot be nullvalue- 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 nullvalue- the attribute value to set, may not be null- Returns:
- the Attribute with specified values
-
createAttribute
public abstract Attribute createAttribute(QName name, String value)
Create a new Attribute- Parameters:
name- the qualified name of the attribute, may not be nullvalue- the attribute value to set, may not be null- Returns:
- the Attribute with specified values
-
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 nullnamespaceUri- the attribute value is set to this value, may not be null- Returns:
- the Namespace with the specified values
-
createStartElement
public abstract StartElement createStartElement(QName name, Iterator<? extends Attribute> attributes, Iterator<? extends Namespace> 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 nullattributes- an optional unordered set of objects that implement Attribute to add to the new StartElement, may be nullnamespaces- 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:
namespaceUri- the uri of the QName of the new StartElementlocalName- the local name of the QName of the new StartElementprefix- the prefix 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<? extends Attribute> attributes, Iterator<? extends Namespace> 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:
namespaceUri- the uri of the QName of the new StartElementlocalName- the local name of the QName of the new StartElementprefix- the prefix of the QName of the new StartElementattributes- an unordered set of objects that implement Attribute to add to the new StartElementnamespaces- 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<? extends Attribute> attributes, Iterator<? extends Namespace> namespaces, NamespaceContext context)
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:
namespaceUri- the uri of the QName of the new StartElementlocalName- the local name of the QName of the new StartElementprefix- the prefix of the QName of the new StartElementattributes- an unordered set of objects that implement Attribute to add to the new StartElement, may be nullnamespaces- an unordered set of objects that implement Namespace to add to the new StartElement, may be nullcontext- the namespace context of this element- Returns:
- an instance of the requested StartElement
-
createEndElement
public abstract EndElement createEndElement(QName name, Iterator<? extends Namespace> namespaces)
Create a new EndElement- Parameters:
name- the qualified name of the EndElementnamespaces- 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:
namespaceUri- the uri of the QName of the new StartElementlocalName- the local name of the QName of the new StartElementprefix- the prefix 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<? extends Namespace> namespaces)
Create a new EndElement- Parameters:
namespaceUri- the uri of the QName of the new StartElementlocalName- the local name of the QName of the new StartElementprefix- the prefix of the QName of the new StartElementnamespaces- 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 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
-
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
-
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
-
createIgnorableSpace
public abstract Characters createIgnorableSpace(String content)
Create an ignorable space- Parameters:
content- 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, String version, boolean standalone)
Creates a new instance of a StartDocument event- Parameters:
encoding- the encoding styleversion- the XML versionstandalone- the status of standalone may be set to "true" or "false"- 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 styleversion- the XML version- 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
-
createEndDocument
public abstract EndDocument createEndDocument()
Creates a new instance of an EndDocument event- Returns:
- an EndDocument event
-
createEntityReference
public abstract EntityReference createEntityReference(String name, EntityDeclaration declaration)
Creates a new instance of a EntityReference event- Parameters:
name- The name of the referencedeclaration- the declaration for the event- Returns:
- an EntityReference event
-
createComment
public abstract Comment createComment(String text)
Create a comment- Parameters:
text- The text of the comment a Comment event
-
createProcessingInstruction
public abstract ProcessingInstruction createProcessingInstruction(String target, String data)
Create a processing instruction- Parameters:
target- The target of the processing instructiondata- The text of the processing instruction- Returns:
- a ProcessingInstruction event
-
-