* Once an application has obtained a reference to a * {@code SAXParserFactory}, it can use the factory to * configure and obtain parser instances. * * * *
* Setting the {@code jaxp.debug} system property will cause * this method to print a lot of debug messages * to {@code System.err} about what it is doing and where it is looking at. * *
* If you have problems loading {@link SAXParser}s, try: *
* java -Djaxp.debug=1 YourProgram ....
*
*
*
* @return A new instance of a SAXParserFactory.
*
* @throws FactoryConfigurationError in case of {@linkplain
* java.util.ServiceConfigurationError service configuration error} or if
* the implementation is not available or cannot be instantiated.
*/
public static SAXParserFactory newInstance() {
return FactoryFinder.find(
/* The default property name according to the JAXP spec */
SAXParserFactory.class,
/* The fallback implementation class name */
DEFAULT_IMPL);
}
/**
* Obtain a new instance of a {@code SAXParserFactory} 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 a {@code SAXParserFactory} * it can use the factory to configure and obtain parser instances. * * *
Setting the {@code jaxp.debug} system property will cause * this method to print a lot of debug messages * to {@code System.err} about what it is doing and where it is looking at. * *
* If you have problems, try: *
* java -Djaxp.debug=1 YourProgram ....
*
*
* @param factoryClassName fully qualified factory class name that provides implementation of {@code javax.xml.parsers.SAXParserFactory}.
*
* @param classLoader {@code ClassLoader} used to load the factory class. If {@code null}
* current {@code Thread}'s context classLoader is used to load the factory class.
*
* @return New instance of a {@code SAXParserFactory}
*
* @throws FactoryConfigurationError if {@code factoryClassName} is {@code null}, or
* the factory class cannot be loaded, instantiated.
*
* @see #newInstance()
*
* @since 1.6
*/
public static SAXParserFactory newInstance(String factoryClassName, ClassLoader classLoader){
//do not fallback if given classloader can't find the class, throw exception
return FactoryFinder.newInstance(SAXParserFactory.class,
factoryClassName, classLoader, false);
}
private static SAXParserFactory makeNSAware(SAXParserFactory spf) {
spf.setNamespaceAware(true);
return spf;
}
/**
* Creates a new instance of a SAXParser using the currently
* configured factory parameters.
*
* @return A new instance of a SAXParser.
*
* @throws ParserConfigurationException if a parser cannot
* be created which satisfies the requested configuration.
* @throws SAXException for SAX errors.
*/
public abstract SAXParser newSAXParser()
throws ParserConfigurationException, SAXException;
/**
* Specifies that the parser produced by this code will
* provide support for XML namespaces. By default the value of this is set
* to {@code false}.
*
* @param awareness true if the parser produced by this code will
* provide support for XML namespaces; false otherwise.
*/
public void setNamespaceAware(boolean awareness) {
this.namespaceAware = awareness;
}
/**
* Specifies that the parser produced by this code will
* validate documents as they are parsed. By default the value of this is
* set to {@code 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.) * *
* 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 {@link #setValidating(boolean)} * method {@code false}, then use the {@link #setSchema(Schema)} * method to associate a schema to a parser. * * @param validating true if the parser produced by this code will * validate documents as they are parsed; false otherwise. */ public void setValidating(boolean validating) { this.validating = validating; } /** * Indicates whether or not the factory is configured to produce * parsers which are namespace aware. * * @return true if the factory is configured to produce * parsers which are namespace aware; false otherwise. */ public boolean isNamespaceAware() { return namespaceAware; } /** * Indicates whether or not the factory is configured to produce * parsers which validate the XML content during parse. * * @return true if the factory is configured to produce parsers which validate * the XML content during parse; false otherwise. */ public boolean isValidating() { return validating; } /** * 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 {@link javax.xml.XMLConstants#FEATURE_SECURE_PROCESSING} feature. * When the feature is *
When a {@link 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 {@link org.xml.sax.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, {@code null} is set as the {@link Schema}. * *
This processing will take effect even if * the {@link #isValidating()} method returns {@code false}. * *
It is an error to use * the {@code http://java.sun.com/xml/jaxp/properties/schemaSource} * property and/or the {@code http://java.sun.com/xml/jaxp/properties/schemaLanguage} * property in conjunction with a non-null {@link Schema} object. * Such configuration will cause a {@link SAXException} * exception when those properties are set on a {@link SAXParser}. * *
* A parser must be able to work with any {@link 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. * * @param schema {@code Schema} to use, {@code null} to remove a schema. * * @throws UnsupportedOperationException When implementation does not * override this method * * @since 1.5 */ public void setSchema(Schema schema) { throw new UnsupportedOperationException( "This parser does not support specification \"" + this.getClass().getPackage().getSpecificationTitle() + "\" version \"" + this.getClass().getPackage().getSpecificationVersion() + "\"" ); } /** * 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 {@code false}. * * @param state Set XInclude processing to {@code true} or * {@code false} * * @throws UnsupportedOperationException When implementation does not * override this method * * @since 1.5 */ public void setXIncludeAware(final boolean state) { if (state) { throw new UnsupportedOperationException(" setXIncludeAware " + "is not supported on this JAXP" + " implementation or earlier: " + this.getClass()); } } /** * Get state of XInclude processing. * * @return current state of XInclude processing * * @throws UnsupportedOperationException When implementation does not * override this method * * @since 1.5 */ public boolean isXIncludeAware() { throw new UnsupportedOperationException( "This parser does not support specification \"" + this.getClass().getPackage().getSpecificationTitle() + "\" version \"" + this.getClass().getPackage().getSpecificationVersion() + "\"" ); } }