Constructor Summary

Method Summary

Constructor Details

• SAXParserFactory

  protected SAXParserFactory()

  Protected constructor to force use ofnewInstance().

Method Details

• newDefaultNSInstance

  public static SAXParserFactory newDefaultNSInstance()

  Creates a new NamespaceAware instance of theSAXParserFactory builtin system-default implementation. Parsers produced by the factory instance provides support for XML namespaces by default.

  Implementation Requirements:

  In addition to creating a factory instance using the same process asnewDefaultInstance(), this method must set NamespaceAware to true.

  Returns:

  a new instance of theSAXParserFactory builtin system-default implementation.

  Since:

  13

• newNSInstance

  public static SAXParserFactory newNSInstance()

  Creates a new NamespaceAware instance of aSAXParserFactory. Parsers produced by the factory instance provides support for XML namespaces by default.

  Implementation Requirements:

  In addition to creating a factory instance using the same process asnewInstance(), this method must set NamespaceAware to true.

  Returns:

  a new instance of theSAXParserFactory

  Throws:

  FactoryConfigurationError - in case ofservice configuration error or if the implementation is not available or cannot be instantiated.

  Since:

  13

• newNSInstance

  public static SAXParserFactory newNSInstance(String factoryClassName,ClassLoader classLoader)

  Creates a new NamespaceAware instance of aSAXParserFactory from the class name. Parsers produced by the factory instance provides support for XML namespaces by default.

  Implementation Requirements:

  In addition to creating a factory instance using the same process asnewInstance(java.lang.String, java.lang.ClassLoader), this method must set NamespaceAware to true.

  Parameters:

  factoryClassName - a fully qualified factory class name that provides implementation ofjavax.xml.parsers.SAXParserFactory.

  classLoader - theClassLoader used to load the factory class. If it isnull, the currentThread's context classLoader is used to load the factory class.

  Returns:

  a new instance of theSAXParserFactory

  Throws:

  FactoryConfigurationError - iffactoryClassName isnull, or the factory class cannot be loaded, instantiated.

  Since:

  13

• newDefaultInstance

  public static SAXParserFactory newDefaultInstance()

  Creates a new instance of theSAXParserFactory builtin system-default implementation.

  Returns:

  A new instance of theSAXParserFactory builtin system-default implementation.

  Since:

  9

• newInstance

  public static SAXParserFactory newInstance()

  Obtains a new instance of aSAXParserFactory. This method uses theJAXP Lookup Mechanism to determine theSAXParserFactory implementation class to load.

  Once an application has obtained a reference to aSAXParserFactory, 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 toSystem.err about what it is doing and where it is looking at.

  If you have problems loadingSAXParsers, try:

   java -Djaxp.debug=1 YourProgram ....

  Returns:

  A new instance of a SAXParserFactory.

  Throws:

  FactoryConfigurationError - in case ofservice configuration error or if the implementation is not available or cannot be instantiated.

• newInstance

  public static SAXParserFactory newInstance(String factoryClassName,ClassLoader classLoader)

  Obtain a new instance of aSAXParserFactory from class name. This function is useful when there are multiple providers in the classpath. It gives more control to the application as it can specify which provider should be loaded.

  Once an application has obtained a reference to aSAXParserFactory 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 toSystem.err about what it is doing and where it is looking at.

  If you have problems, try:

   java -Djaxp.debug=1 YourProgram ....

  Parameters:

  factoryClassName - fully qualified factory class name that provides implementation ofjavax.xml.parsers.SAXParserFactory.

  classLoader -ClassLoader used to load the factory class. Ifnull currentThread's context classLoader is used to load the factory class.

  Returns:

  New instance of aSAXParserFactory

  Throws:

  FactoryConfigurationError - iffactoryClassName isnull, or the factory class cannot be loaded, instantiated.

  Since:

  1.6

  See Also:

  • newInstance()

• newSAXParser

  public abstract SAXParser newSAXParser() throwsParserConfigurationException,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.

• setNamespaceAware

  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.

• setValidating

  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 meansa 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.)

  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) methodfalse, 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.

• isNamespaceAware

  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.

• isValidating

  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.

• setFeature

  public abstract void setFeature(String name, boolean value) throwsParserConfigurationException,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 athttp://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 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 registeredErrorHandler.fatalError(SAXParseException exception). SeeSAXParserparse methods for handler specification.
  • When the feature isfalse, 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.

  NullPointerException - If thename parameter is null.

  See Also:

  • XMLReader.setFeature(java.lang.String, boolean)

• getFeature

  public abstract boolean getFeature(String name) throwsParserConfigurationException,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(java.lang.String)

• getSchema

  public Schema getSchema()

  Gets theSchema object specified through thesetSchema(Schema schema) method.

  Returns:

  theSchema object that was last set through thesetSchema(Schema) method, or null if the method was not invoked since aSAXParserFactory is created.

  Throws:

  UnsupportedOperationException - When implementation does not override this method

  Since:

  1.5

• setSchema

  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.

  Initially,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 implementors

  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.

  Throws:

  UnsupportedOperationException - When implementation does not override this method

  Since:

  1.5

• setXIncludeAware

  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

  Throws:

  UnsupportedOperationException - When implementation does not override this method

  Since:

  1.5

• isXIncludeAware

  public boolean isXIncludeAware()

  Get state of XInclude processing.

  Returns:

  current state of XInclude processing

  Throws:

  UnsupportedOperationException - When implementation does not override this method

  Since:

  1.5