Added in API level 1

Summary: Protected Ctors | Methods | Inherited Methods

SAXParserFactory

public abstract class SAXParserFactory
extends Object

java.lang.Object
↳	javax.xml.parsers.SAXParserFactory

Defines a factory API that enables applications to configure and obtain a SAX based parser to parse XML documents.

Summary

Protected constructors
`SAXParserFactory()` Protected constructor to force use of `newInstance()`.

Protected constructors


      SAXParserFactory()

Protected constructor to force use of newInstance().

Public methods
`abstract boolean`	`getFeature(String name)` Returns the particular property requested for in the underlying implementation of org.xml.sax.XMLReader.
`Schema`	`getSchema()` Gets the `Schema` object specified through the `setSchema(javax.xml.validation.Schema)` method.
`boolean`	`isNamespaceAware()` Indicates whether or not the factory is configured to produce parsers which are namespace aware.
`boolean`	`isValidating()` Indicates whether or not the factory is configured to produce parsers which validate the XML content during parse.
`boolean`	`isXIncludeAware()` Get state of XInclude processing.
`static SAXParserFactory`	`newInstance(String factoryClassName, ClassLoader classLoader)` Returns an instance of the named implementation of `SAXParserFactory`.
`static SAXParserFactory`	`newInstance()` Returns Android's implementation of `SAXParserFactory`.
`abstract SAXParser`	`newSAXParser()` Creates a new instance of a SAXParser using the currently configured factory parameters.
`abstract void`	`setFeature(String name, boolean value)` Sets the particular feature in the underlying implementation of org.xml.sax.XMLReader.
`void`	`setNamespaceAware(boolean awareness)` Specifies that the parser produced by this code will provide support for XML namespaces.
`void`	`setSchema(Schema schema)` Set the `Schema` to be used by parsers created from this factory.
`void`	`setValidating(boolean validating)` Specifies that the parser produced by this code will validate documents as they are parsed.
`void`	`setXIncludeAware(boolean state)` Set state of XInclude processing.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Protected constructors

SAXParserFactory

Added in API level 1

protected SAXParserFactory ()

Protected constructor to force use of newInstance().

Public methods

getFeature

Added in API level 1

public abstract boolean getFeature (String name)

Returns the particular property requested for in the underlying implementation of org.xml.sax.XMLReader.

Parameters
`name`	`String`: The name of the property to be retrieved.

Returns
`boolean`	Value of the requested property.

Throws
`ParserConfigurationException`	if a parser cannot be created which satisfies the requested configuration.
`SAXNotRecognizedException`	When the underlying XMLReader does not recognize the property name.
`SAXNotSupportedException`	When the underlying XMLReader recognizes the property name but doesn't support the property.

See also:

XMLReader.getProperty(String)

getSchema

Added in API level 8

public Schema getSchema ()

Gets the Schema object specified through the setSchema(javax.xml.validation.Schema) method.

Returns
`Schema`	the `Schema` object that was last set through the `setSchema(javax.xml.validation.Schema)` method, or null if the method was not invoked since a `SAXParserFactory` is created.

Throws
`UnsupportedOperationException`	For backward compatibility, when implementations for earlier versions of JAXP is used, this exception will be thrown.

isNamespaceAware

Added in API level 1

public boolean isNamespaceAware ()

Indicates whether or not the factory is configured to produce parsers which are namespace aware.

Returns
`boolean`	true if the factory is configured to produce parsers which are namespace aware; false otherwise.

isValidating

Added in API level 1

public boolean isValidating ()

Indicates whether or not the factory is configured to produce parsers which validate the XML content during parse.

Returns
`boolean`	true if the factory is configured to produce parsers which validate the XML content during parse; false otherwise.

isXIncludeAware

Added in API level 1

public boolean isXIncludeAware ()

Get state of XInclude processing.

Returns
`boolean`	current state of XInclude processing

Throws
`UnsupportedOperationException`	For backward compatibility, when implementations for earlier versions of JAXP is used, this exception will be thrown.

newInstance

Added in API level 9

public static SAXParserFactory newInstance (String factoryClassName, 
                ClassLoader classLoader)

Returns an instance of the named implementation of SAXParserFactory.

Parameters
`factoryClassName`	`String`
`classLoader`	`ClassLoader`

Returns
`SAXParserFactory`

Throws
`FactoryConfigurationError`	if `factoryClassName` is not available or cannot be instantiated.

newInstance

Added in API level 1

public static SAXParserFactory newInstance ()

Returns Android's implementation of SAXParserFactory. Unlike other Java implementations, this method does not consult system properties, property files, or the services API.

Returns
`SAXParserFactory`	a new SAXParserFactory.

Throws
`FactoryConfigurationError`	never. Included for API compatibility with other Java implementations.

newSAXParser

Added in API level 1

public abstract SAXParser newSAXParser ()

Creates a new instance of a SAXParser using the currently configured factory parameters.

Returns
`SAXParser`	A new instance of a SAXParser.

Throws
`ParserConfigurationException`	if a parser cannot be created which satisfies the requested configuration.
`SAXException`	for SAX errors.

setFeature

Added in API level 1

public abstract void setFeature (String name, 
                boolean value)

Sets the particular feature in the underlying implementation of org.xml.sax.XMLReader. A list of the core features and properties can be found at http://www.saxproject.org/

All implementations are required to support the XMLConstants.FEATURE_SECURE_PROCESSING feature. When the feature is

true: the implementation will limit XML processing to conform to implementation limits. Examples include entity expansion limits and XML Schema constructs that would consume large amounts of resources. If XML processing is limited for security reasons, it will be reported via a call to the registered ErrorHandler.fatalError(SAXParseException). See SAXParser parse methods for handler specification.
When the feature is false, the implementation will processing XML according to the XML specifications without regard to possible implementation limits.

Parameters
`name`	`String`: The name of the feature to be set.
`value`	`boolean`: The value of the feature to be set.

Throws
`ParserConfigurationException`	if a parser cannot be created which satisfies the requested configuration.
`SAXNotRecognizedException`	When the underlying XMLReader does not recognize the property name.
`SAXNotSupportedException`	When the underlying XMLReader recognizes the property name but doesn't support the property.
`NullPointerException`	If the `name` parameter is null.

See also:

XMLReader.setFeature(String, boolean)

setNamespaceAware

Added in API level 1

public void setNamespaceAware (boolean awareness)

Specifies that the parser produced by this code will provide support for XML namespaces. By default the value of this is set to false.

Parameters
`awareness`	`boolean`: true if the parser produced by this code will provide support for XML namespaces; false otherwise.

setSchema

Added in API level 8

public void setSchema (Schema schema)

Set the Schema to be used by parsers created from this factory.

When a Schema is non-null, a parser will use a validator created from it to validate documents before it passes information down to the application.

When warnings/errors/fatal errors are found by the validator, the parser must handle them as if those errors were found by the parser itself. In other words, if the user-specified ErrorHandler is set, it must receive those errors, and if not, they must be treated according to the implementation specific default error handling rules.

A validator may modify the SAX event stream (for example by adding default values that were missing in documents), and a parser is responsible to make sure that the application will receive those modified event stream.

Initially, null is set as the Schema.

This processing will take effect even if the isValidating() method returns false.

It is an error to use the http://java.sun.com/xml/jaxp/properties/schemaSource property and/or the http://java.sun.com/xml/jaxp/properties/schemaLanguage property in conjunction with a non-null Schema object. Such configuration will cause a SAXException exception when those properties are set on a SAXParser.

Note for implementors

A parser must be able to work with any Schema implementation. However, parsers and schemas are allowed to use implementation-specific custom mechanisms as long as they yield the result described in the specification.

Parameters
`schema`	`Schema`: `Schema` to use, `null` to remove a schema.

Throws
`UnsupportedOperationException`	For backward compatibility, when implementations for earlier versions of JAXP is used, this exception will be thrown.

setValidating

Added in API level 1

public void setValidating (boolean validating)

Specifies that the parser produced by this code will validate documents as they are parsed. By default the value of this is set to false.

Note that "the validation" here means a validating parser as defined in the XML recommendation. In other words, it essentially just controls the DTD validation. (except the legacy two properties defined in JAXP 1.2. See here for more details.)

To use modern schema languages such as W3C XML Schema or RELAX NG instead of DTD, you can configure your parser to be a non-validating parser by leaving the setValidating(boolean) method false, then use the setSchema(javax.xml.validation.Schema) method to associate a schema to a parser.

Parameters
`validating`	`boolean`: true if the parser produced by this code will validate documents as they are parsed; false otherwise.

setXIncludeAware

Added in API level 1

public void setXIncludeAware (boolean state)

Set state of XInclude processing.

If XInclude markup is found in the document instance, should it be processed as specified in XML Inclusions (XInclude) Version 1.0.

XInclude processing defaults to false.

Parameters
`state`	`boolean`: Set XInclude processing to `true` or `false`

Throws
`UnsupportedOperationException`	For backward compatibility, when implementations for earlier versions of JAXP is used, this exception will be thrown.