| javolution.xml.sax.XMLReader
All known Subclasses: javolution.xml.sax.XMLReaderImpl, javolution.xml.sax.SAX2ReaderImpl,
Method Summary | |
public ContentHandler | getContentHandler() Return the current content handler. | public DTDHandler | getDTDHandler() Return the current DTD handler. | public EntityResolver | getEntityResolver() Return the current entity resolver. | public ErrorHandler | getErrorHandler() Return the current error handler. | public boolean | getFeature(String name) Look up the value of a feature flag.
The feature name is any fully-qualified URI. | public Object | getProperty(String name) Look up the value of a property.
The property name is any fully-qualified URI. | public void | parse(InputSource input) Parse an XML document.
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). | public void | parse(String systemId) Parse an XML document from a system identifier (URI).
This method is a shortcut for the common case of reading a
document from a system identifier. | public void | setContentHandler(ContentHandler handler) Allow an application to register a content event handler. | public void | setDTDHandler(DTDHandler handler) Allow an application to register a DTD event handler. | public void | setEntityResolver(EntityResolver resolver) Allow an application to register an entity resolver. | public void | setErrorHandler(ErrorHandler handler) 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. | public void | setFeature(String name, boolean value) Set the value of a feature flag.
The feature name is any fully-qualified URI. | public void | setProperty(String name, Object value) Set the value of a property.
The property name is any fully-qualified URI. |
getFeature | public boolean getFeature(String name) throws SAXNotRecognizedException, SAXNotSupportedException(Code) | | Look up the value of a feature flag.
The feature name is any fully-qualified URI. It is
possible for an XMLReader to recognize a feature name but
temporarily be unable to return its value.
Some feature values may be available only in specific
contexts, such as before, during, or after a parse.
Also, some feature values may not be programmatically accessible.
(In the case of an adapter for SAX1
org.xml.sax.Parser , there
is no implementation-independent way to expose whether the underlying
parser is performing validation, expanding external entities,
and so forth.)
All XMLReaders are required to recognize the
http://xml.org/sax/features/namespaces and the
http://xml.org/sax/features/namespace-prefixes feature names.
Typical usage is something like this:
XMLReader r = new MySAXDriver();
// try to activate validation
try {
r.setFeature("http://xml.org/sax/features/validation", true);
} catch (SAXException e) {
System.err.println("Cannot activate validation.");
}
// register event handlers
r.setContentHandler(new MyContentHandler());
r.setErrorHandler(new MyErrorHandler());
// parse the first document
try {
r.parse("http://www.foo.com/mydoc.xml");
} catch (IOException e) {
System.err.println("I/O exception reading XML document");
} catch (SAXException e) {
System.err.println("XML exception reading document.");
}
Implementors are free (and encouraged) to invent their own features,
using names built on their own URIs.
Parameters: name - The feature name, which is a fully-qualified URI. The current value of the feature (true or false). exception: org.xml.sax.SAXNotRecognizedException - If the featurevalue can't be assigned or retrieved. exception: org.xml.sax.SAXNotSupportedException - When theXMLReader recognizes the feature name but cannot determine its value at this time. See Also: XMLReader.setFeature |
getProperty | public Object getProperty(String name) throws SAXNotRecognizedException, SAXNotSupportedException(Code) | | 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
temporarily be unable to return its value.
Some property values may be available only in specific
contexts, such as before, during, or after a parse.
XMLReaders are not required to recognize any specific
property names, though an initial core set is documented for
SAX2.
Implementors are free (and encouraged) to invent their own properties,
using names built on their own URIs.
Parameters: name - The property name, which is a fully-qualified URI. The current value of the property. exception: org.xml.sax.SAXNotRecognizedException - If the propertyvalue can't be assigned or retrieved. exception: org.xml.sax.SAXNotSupportedException - When theXMLReader recognizes the property name but cannot determine its value at this time. See Also: XMLReader.setProperty |
parse | public void parse(InputSource input) throws IOException, SAXException(Code) | | Parse an XML document.
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.
Configuration of the XMLReader object (such as handler bindings and
values established for feature flags and properties) is unchanged
by completion of a parse, unless the definition of that aspect of
the configuration explicitly specifies other behavior.
(For example, feature flags or properties exposing
characteristics of the document being parsed.)
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.
Parameters: input - The input source for the top-level of theXML document. exception: org.xml.sax.SAXException - Any SAX exception, possiblywrapping another exception. exception: j2me.io.IOException - An IO exception from the parser,possibly from a byte stream or character streamsupplied by the application. See Also: org.xml.sax.InputSource See Also: XMLReader.setEntityResolver See Also: XMLReader.setDTDHandler See Also: XMLReader.setContentHandler See Also: XMLReader.setErrorHandler See Also: |
parse | public void parse(String systemId) throws IOException, SAXException(Code) | | Parse an XML document from 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.
Parameters: systemId - The system identifier (URI). exception: org.xml.sax.SAXException - Any SAX exception, possiblywrapping another exception. exception: j2me.io.IOException - An IO exception from the parser,possibly from a byte stream or character streamsupplied by the application. See Also: XMLReader.parse(org.xml.sax.InputSource) |
setContentHandler | public void setContentHandler(ContentHandler handler)(Code) | | Allow an application to register a content event 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.
Parameters: handler - The content handler. See Also: XMLReader.getContentHandler |
setDTDHandler | public void setDTDHandler(DTDHandler handler)(Code) | | 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.
Parameters: handler - The DTD handler. See Also: XMLReader.getDTDHandler |
setEntityResolver | public void setEntityResolver(EntityResolver resolver)(Code) | | 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.
Parameters: resolver - The entity resolver. See Also: XMLReader.getEntityResolver |
setErrorHandler | public void setErrorHandler(ErrorHandler handler)(Code) | | 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.
Parameters: handler - The error handler. See Also: XMLReader.getErrorHandler |
setFeature | public void setFeature(String name, boolean value) throws SAXNotRecognizedException, SAXNotSupportedException(Code) | | Set the value of a feature flag.
The feature name is any fully-qualified URI. It is
possible for an XMLReader to expose a feature value but
to be unable to change the current value.
Some feature values may be immutable or mutable only
in specific contexts, such as before, during, or after
a parse.
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.
Parameters: name - The feature name, which is a fully-qualified URI. Parameters: value - The requested value of the feature (true or false). exception: org.xml.sax.SAXNotRecognizedException - If the featurevalue can't be assigned or retrieved. exception: org.xml.sax.SAXNotSupportedException - When theXMLReader recognizes the feature name but cannot set the requested value. See Also: XMLReader.getFeature |
setProperty | public void setProperty(String name, Object value) throws SAXNotRecognizedException, SAXNotSupportedException(Code) | | 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 change the current value.
Some property values may be immutable or mutable only
in specific contexts, such as before, during, or after
a parse.
XMLReaders are not required to recognize setting
any specific property names, though a core set is defined by
SAX2.
This method is also the standard mechanism for setting
extended handlers.
Parameters: name - The property name, which is a fully-qualified URI. Parameters: value - The requested value for the property. exception: org.xml.sax.SAXNotRecognizedException - If the propertyvalue can't be assigned or retrieved. exception: org.xml.sax.SAXNotSupportedException - When theXMLReader recognizes the property name but cannot set the requested value. |
|
|