Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
javax.xml.parsers.SAXParserFactory
public abstract class SAXParserFactory
extends java.lang.Object
Constructor Summary | |
|
Method Summary | |
abstract boolean |
|
Schema | |
boolean |
|
boolean |
|
boolean |
|
static SAXParserFactory |
|
abstract SAXParser |
|
abstract void |
|
void |
|
void | |
void |
|
void |
|
public abstract boolean getFeature(String name) throws ParserConfigurationException, SAXNotRecognizedException, SAXNotSupportedException
Returns the particular property requested for in the underlying implementation of org.xml.sax.XMLReader.
- Parameters:
name
- The name of the property to be retrieved.
- Returns:
- 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)
public Schema getSchema()
Gets theSchema
object specified through thesetSchema(Schema schema)
method.
- Returns:
- the
Schema
object that was last set through thesetSchema(Schema)
method, or null if the method was not invoked since aSAXParserFactory
is created.
- Since:
- 1.5
public boolean isNamespaceAware()
Indicates whether or not the factory is configured to produce parsers which are namespace aware.
- Returns:
- true if the factory is configured to produce parsers which are namespace aware; false otherwise.
public boolean isValidating()
Indicates whether or not the factory is configured to produce parsers which validate the XML content during parse.
- Returns:
- true if the factory is configured to produce parsers which validate the XML content during parse; false otherwise.
public boolean isXIncludeAware()
Get state of XInclude processing.
- Returns:
- current state of XInclude processing
- Since:
- 1.5
public static SAXParserFactory newInstance()
Obtain a new instance of aSAXParserFactory
. This static method creates a new factory instance This method uses the following ordered lookup procedure to determine theSAXParserFactory
implementation class to load:Once an application has obtained a reference to a
- Use the
javax.xml.parsers.SAXParserFactory
system property.- Use the properties file "lib/jaxp.properties" in the JRE directory. This configuration file is in standard
java.util.Properties
format and contains the fully qualified name of the implementation class with the key being the system property defined above. The jaxp.properties file is read only once by the JAXP implementation and it's 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 jaxp.properties after it has been read for the first time.- Use the Services API (as detailed in the JAR specification), if available, to determine the classname. The Services API will look for a classname in the file
META-INF/services/javax.xml.parsers.SAXParserFactory
in jars available to the runtime.- Platform default
SAXParserFactory
instance.SAXParserFactory
it can use the factory to configure and obtain parser instances.Tip for Trouble-shooting
Setting thejaxp.debug
system property will cause this method to print a lot of debug messages to System.err about what it is doing and where it is looking at. If you have problems loadingDocumentBuilder
s, try:java -Djaxp.debug=1 YourProgram ....
- Returns:
- A new instance of a SAXParserFactory.
public abstract SAXParser newSAXParser() throws ParserConfigurationException, SAXException
Creates a new instance of a SAXParser using the currently configured factory parameters.
- Returns:
- A new instance of a SAXParser.
- Throws:
ParserConfigurationException
- if a parser cannot be created which satisfies the requested configuration.SAXException
- for SAX errors.
public abstract void setFeature(String name, boolean value) throws ParserConfigurationException, SAXNotRecognizedException, SAXNotSupportedException
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 theXMLConstants.FEATURE_SECURE_PROCESSING
feature. When the feature is
true
: the implementation will limit XML processing to conform to implementation limits. Examples include enity 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 registeredorg.xml.sax.ErrorHandler.fatalError(SAXParseException exception)
. SeeSAXParser
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
- The name of the feature to be set.value
- 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.
- See Also:
XMLReader.setFeature(String,boolean)
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 tofalse
.
- Parameters:
awareness
- true if the parser produced by this code will provide support for XML namespaces; false otherwise.
public void setSchema(Schema schema)
Set theSchema
to be used by parsers created from this factory. When aSchema
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-specifiedErrorHandler
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. Initialy,null
is set as theSchema
. This processing will take effect even if theisValidating()
method returnsfalse
. It is an error to use thehttp://java.sun.com/xml/jaxp/properties/schemaSource
property and/or thehttp://java.sun.com/xml/jaxp/properties/schemaLanguage
property in conjunction with a non-nullSchema
object. Such configuration will cause aSAXException
exception when those properties are set on aSAXParser
.Note for implmentors
A parser must be able to work with anySchema
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
to use,null
to remove a schema.
- Since:
- 1.5
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 tofalse
. 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 thesetValidating(boolean)
method false, then use thesetSchema(Schema)
method to associate a schema to a parser.
- Parameters:
validating
- true if the parser produced by this code will validate documents as they are parsed; false otherwise.
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 tofalse
.
- Parameters:
state
- Set XInclude processing totrue
orfalse
- Since:
- 1.5