Class AbstractXMLFilter
- Direct Known Subclasses:
FilterImpl
,StreamingFilterImpl
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionGet the ContentHandler registered using setContentHandler()Return the current DTD handler.Return the current entity resolver.Return the current error handler.boolean
getFeature
(String name) Look up the value of a feature.Get the parent reader.getProperty
(String name) Look up the value of a property.void
Parse (that is, transform) an XML document given a system identifier (URI).void
setContentHandler
(ContentHandler handler) Register a content handler to receive the output of the transformation filter.void
setDTDHandler
(DTDHandler handler) Allow an application to register a DTD event handler.void
setEntityResolver
(EntityResolver resolver) Allow an application to register an entity resolver.void
setErrorHandler
(ErrorHandler handler) Allow an application to register an error event handler.void
setFeature
(String name, boolean value) Set the state of a feature.void
Set the parent reader.void
setProperty
(String name, Object value) Set the value of a property.
-
Constructor Details
-
AbstractXMLFilter
public AbstractXMLFilter()
-
-
Method Details
-
setParent
Set the parent reader.This method allows the application to link the filter to a parent reader (which may be another filter). The argument may not be null.
-
getParent
Get the parent reader.This method allows the application to query the parent reader (which may be another filter). It is generally a bad idea to perform any operations on the parent reader directly: they should all pass through this filter.
-
getFeature
Look up the value of a feature.The feature name is any fully-qualified URI. It is possible for an XMLReader to recognize a feature name but to be unable to return its value; this is especially true in the case of an adapter for a SAX1 Parser, which has no way of knowing whether the underlying parser is performing validation or expanding external entities.
All XMLReaders are required to recognize the http://xml.org/sax/features/namespaces and the http://xml.org/sax/features/namespace-prefixes feature names.
- Specified by:
getFeature
in interfaceXMLReader
- Parameters:
name
- The feature name, which is a fully-qualified URI.- Returns:
- The current state of the feature (true or false).
- Throws:
SAXNotRecognizedException
- When the XMLReader does not recognize the feature name.SAXNotSupportedException
- When the XMLReader recognizes the feature name but cannot determine its value at this time.- See Also:
-
setFeature
public void setFeature(String name, boolean value) throws SAXNotRecognizedException, SAXNotSupportedException Set the state of a feature.The feature name is any fully-qualified URI. It is possible for an XMLReader to recognize a feature name but to be unable to set its value
All XMLReaders are required to support setting http://xml.org/sax/features/namespaces to true and http://xml.org/sax/features/namespace-prefixes to false.
Some feature values may be immutable or mutable only in specific contexts, such as before, during, or after a parse.
- Specified by:
setFeature
in interfaceXMLReader
- Parameters:
name
- The feature name, which is a fully-qualified URI.value
- The requested state of the feature (true or false).- Throws:
SAXNotRecognizedException
- When the XMLReader does not recognize the feature name.SAXNotSupportedException
- When the XMLReader recognizes the feature name but cannot set the requested value.- See Also:
-
getProperty
Look up the value of a property.The property name is any fully-qualified URI. It is possible for an XMLReader to recognize a property name but to be unable to return its state.
XMLReaders are not required to recognize any specific property names, though an initial core set is documented for SAX2.
Some property values may be available only in specific contexts, such as before, during, or after a parse.
Implementors are free (and encouraged) to invent their own properties, using names built on their own URIs.
- Specified by:
getProperty
in interfaceXMLReader
- Parameters:
name
- The property name, which is a fully-qualified URI.- Returns:
- The current value of the property.
- Throws:
SAXNotRecognizedException
- When the XMLReader does not recognize the property name.- See Also:
-
setProperty
public void setProperty(String name, Object value) throws SAXNotRecognizedException, SAXNotSupportedException Set the value of a property.The property name is any fully-qualified URI. It is possible for an XMLReader to recognize a property name but to be unable to set its value.
XMLReaders are not required to recognize setting any specific property names, though a core set is provided with SAX2.
Some property values may be immutable or mutable only in specific contexts, such as before, during, or after a parse.
This method is also the standard mechanism for setting extended handlers.
- Specified by:
setProperty
in interfaceXMLReader
- Parameters:
name
- The property name, which is a fully-qualified URI.value
- The requested value for the property.- Throws:
SAXNotRecognizedException
- When the XMLReader does not recognize the property name.SAXNotSupportedException
- When the XMLReader recognizes the property name but cannot set the requested value.
-
setContentHandler
Register a content handler to receive the output of the transformation filter. If the content handler is also a LexicalHandler, and if no LexicalHandler is separately registered, the ContentHandler will also act as the LexicalHandler- Specified by:
setContentHandler
in interfaceXMLReader
-
getContentHandler
Get the ContentHandler registered using setContentHandler()- Specified by:
getContentHandler
in interfaceXMLReader
-
setEntityResolver
Allow an application to register an entity resolver.If the application does not register an entity resolver, the XMLReader will perform its own default resolution.
Applications may register a new or different resolver in the middle of a parse, and the SAX parser must begin using the new resolver immediately.
- Specified by:
setEntityResolver
in interfaceXMLReader
- Parameters:
resolver
- The entity resolver.- Throws:
NullPointerException
- If the resolver argument is null.- See Also:
-
getEntityResolver
Return the current entity resolver.- Specified by:
getEntityResolver
in interfaceXMLReader
- Returns:
- Always null, since no entity resolver is used even if one is supplied.
- See Also:
-
setDTDHandler
Allow an application to register a DTD event handler.If the application does not register a DTD handler, all DTD events reported by the SAX parser will be silently ignored.
Applications may register a new or different handler in the middle of a parse, and the SAX parser must begin using the new handler immediately.
- Specified by:
setDTDHandler
in interfaceXMLReader
- Parameters:
handler
- The DTD handler.- Throws:
NullPointerException
- If the handler argument is null.- See Also:
-
getDTDHandler
Return the current DTD handler.- Specified by:
getDTDHandler
in interfaceXMLReader
- Returns:
- Always null, since no DTD handler is used even if one has been supplied.
- See Also:
-
setErrorHandler
Allow an application to register an error event handler.If the application does not register an error handler, all error events reported by the SAX parser will be silently ignored; however, normal processing may not continue. It is highly recommended that all SAX applications implement an error handler to avoid unexpected bugs.
Applications may register a new or different handler in the middle of a parse, and the SAX parser must begin using the new handler immediately.
- Specified by:
setErrorHandler
in interfaceXMLReader
- Parameters:
handler
- The error handler.- Throws:
NullPointerException
- If the handler argument is null.- See Also:
-
getErrorHandler
Return the current error handler.- Specified by:
getErrorHandler
in interfaceXMLReader
- Returns:
- The current error handler, or null if none has been registered.
- See Also:
-
parse
Parse (that is, transform) an XML document given a system identifier (URI).This method is a shortcut for the common case of reading a document from a system identifier. It is the exact equivalent of the following:
parse(new InputSource(systemId));
If the system identifier is a URL, it must be fully resolved by the application before it is passed to the parser.
- Specified by:
parse
in interfaceXMLReader
- Parameters:
systemId
- The system identifier (URI).- Throws:
SAXException
- Any SAX exception, possibly wrapping another exception.IOException
- An IO exception from the parser, possibly from a byte stream or character stream supplied by the application.- See Also:
-