public class TXMLReaderDecorator
extends java.lang.Object
implements org.xml.sax.XMLReader
Constructor and Description |
---|
TXMLReaderDecorator() |
Modifier and Type | Method and Description |
---|---|
org.xml.sax.ContentHandler |
getContentHandler()
Return the current content handler.
|
org.xml.sax.DTDHandler |
getDTDHandler()
Return the current DTD handler.
|
org.xml.sax.EntityResolver |
getEntityResolver()
Return the current entity resolver.
|
org.xml.sax.ErrorHandler |
getErrorHandler()
Return the current error handler.
|
boolean |
getFeature(java.lang.String name) |
java.lang.Object |
getProperty(java.lang.String name)
Look up the value of a property.
|
void |
parse(org.xml.sax.InputSource input)
Parse an XML document.
|
void |
parse(java.lang.String systemId)
Parse an XML document from a system identifier (URI).
|
void |
setContentHandler(org.xml.sax.ContentHandler handler)
Allow an application to register a content event handler.
|
void |
setDTDHandler(org.xml.sax.DTDHandler handler)
Allow an application to register a DTD event handler.
|
void |
setEntityResolver(org.xml.sax.EntityResolver resolver)
Allow an application to register an entity resolver.
|
void |
setErrorHandler(org.xml.sax.ErrorHandler handler)
Allow an application to register an error event handler.
|
void |
setFeature(java.lang.String name,
boolean value)
Set the state of a feature.
|
void |
setProperty(java.lang.String name,
java.lang.Object value)
Set the value of a property.
|
void |
setQueryContentHandler(org.xml.sax.ContentHandler queryContentHandler) |
void |
setQueryDeclHandler(org.xml.sax.ext.DeclHandler queryDeclHandler) |
void |
setQueryLexicalHandler(org.xml.sax.ext.LexicalHandler lexicalHandler) |
public void setQueryContentHandler(org.xml.sax.ContentHandler queryContentHandler)
public void setQueryDeclHandler(org.xml.sax.ext.DeclHandler queryDeclHandler)
public void setQueryLexicalHandler(org.xml.sax.ext.LexicalHandler lexicalHandler)
public boolean getFeature(java.lang.String name) throws org.xml.sax.SAXNotRecognizedException, org.xml.sax.SAXNotSupportedException
getFeature
in interface org.xml.sax.XMLReader
org.xml.sax.SAXNotRecognizedException
org.xml.sax.SAXNotSupportedException
public void setFeature(java.lang.String name, boolean value) throws org.xml.sax.SAXNotRecognizedException, org.xml.sax.SAXNotSupportedException
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; this is especially true in the case of an adapter for SAX1 Parser, which has no way of affecting whether the underlying parser is validating, for example.
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.
setFeature
in interface org.xml.sax.XMLReader
name
- The feature name, which is a fully-qualified URI.state
- The requested state of the feature (true or false).org.xml.sax.SAXNotRecognizedException
- When the
XMLReader does not recognize the feature name.org.xml.sax.SAXNotSupportedException
- When the
XMLReader recognizes the feature name but
cannot set the requested value.getFeature(java.lang.String)
public java.lang.Object getProperty(java.lang.String name) throws org.xml.sax.SAXNotRecognizedException, org.xml.sax.SAXNotSupportedException
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; this is especially true in the case of an adapter for a SAX1 Parser
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.
getProperty
in interface org.xml.sax.XMLReader
name
- The property name, which is a fully-qualified URI.org.xml.sax.SAXNotRecognizedException
- When the
XMLReader does not recognize the property name.org.xml.sax.SAXNotSupportedException
- When the
XMLReader recognizes the property name but
cannot determine its value at this time.setProperty(java.lang.String, java.lang.Object)
public void setProperty(java.lang.String name, java.lang.Object value) throws org.xml.sax.SAXNotRecognizedException, org.xml.sax.SAXNotSupportedException
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; this is especially true in the case of an adapter for a SAX1 Parser
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.
setProperty
in interface org.xml.sax.XMLReader
name
- The property name, which is a fully-qualified URI.state
- The requested value for the property.org.xml.sax.SAXNotRecognizedException
- When the
XMLReader does not recognize the property name.org.xml.sax.SAXNotSupportedException
- When the
XMLReader recognizes the property name but
cannot set the requested value.public void setEntityResolver(org.xml.sax.EntityResolver 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.
setEntityResolver
in interface org.xml.sax.XMLReader
resolver
- The entity resolver.java.lang.NullPointerException
- If the resolver
argument is null.getEntityResolver()
public org.xml.sax.EntityResolver getEntityResolver()
getEntityResolver
in interface org.xml.sax.XMLReader
setEntityResolver(org.xml.sax.EntityResolver)
public void setDTDHandler(org.xml.sax.DTDHandler 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.
setDTDHandler
in interface org.xml.sax.XMLReader
handler
- The DTD handler.java.lang.NullPointerException
- If the handler
argument is null.getDTDHandler()
public org.xml.sax.DTDHandler getDTDHandler()
getDTDHandler
in interface org.xml.sax.XMLReader
setDTDHandler(org.xml.sax.DTDHandler)
public void setContentHandler(org.xml.sax.ContentHandler handler)
If the application does not register a content handler, all content 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.
setContentHandler
in interface org.xml.sax.XMLReader
handler
- The content handler.java.lang.NullPointerException
- If the handler
argument is null.getContentHandler()
public org.xml.sax.ContentHandler getContentHandler()
getContentHandler
in interface org.xml.sax.XMLReader
setContentHandler(org.xml.sax.ContentHandler)
public void setErrorHandler(org.xml.sax.ErrorHandler 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.
setErrorHandler
in interface org.xml.sax.XMLReader
handler
- The error handler.java.lang.NullPointerException
- If the handler
argument is null.getErrorHandler()
public org.xml.sax.ErrorHandler getErrorHandler()
getErrorHandler
in interface org.xml.sax.XMLReader
setErrorHandler(org.xml.sax.ErrorHandler)
public void parse(org.xml.sax.InputSource input) throws java.io.IOException, org.xml.sax.SAXException
The application can use this method to instruct the XML reader to begin parsing an XML document from any valid input source (a character stream, a byte stream, or a URI).
Applications may not invoke this method while a parse is in progress (they should create a new XMLReader instead for each nested XML document). Once a parse is complete, an application may reuse the same XMLReader object, possibly with a different input source.
During the parse, the XMLReader will provide information about the XML document through the registered event handlers.
This method is synchronous: it will not return until parsing has ended. If a client application wants to terminate parsing early, it should throw an exception.
parse
in interface org.xml.sax.XMLReader
source
- The input source for the top-level of the
XML document.org.xml.sax.SAXException
- Any SAX exception, possibly
wrapping another exception.java.io.IOException
- An IO exception from the parser,
possibly from a byte stream or character stream
supplied by the application.InputSource
,
parse(java.lang.String)
,
setEntityResolver(org.xml.sax.EntityResolver)
,
setDTDHandler(org.xml.sax.DTDHandler)
,
setContentHandler(org.xml.sax.ContentHandler)
,
setErrorHandler(org.xml.sax.ErrorHandler)
public void parse(java.lang.String systemId) throws java.io.IOException, org.xml.sax.SAXException
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.
parse
in interface org.xml.sax.XMLReader
systemId
- The system identifier (URI).org.xml.sax.SAXException
- Any SAX exception, possibly
wrapping another exception.java.io.IOException
- An IO exception from the parser,
possibly from a byte stream or character stream
supplied by the application.parse(org.xml.sax.InputSource)
Copyright (c) 2017 Software AG. All Rights Reserved.