org.xml.sax.helpers
Class XMLReaderAdapter

java.lang.Object
  |
  +--org.xml.sax.helpers.XMLReaderAdapter
All Implemented Interfaces:
ContentHandler, Parser

public synchronized class XMLReaderAdapter
extends java.lang.Object
implements Parser, ContentHandler


Constructor Summary
XMLReaderAdapter()
           
XMLReaderAdapter(XMLReader)
           
 
Method Summary
 void characters(char[], int, int)
           
 void endDocument()
           
 void endElement(java.lang.String, java.lang.String, java.lang.String)
           
 void endPrefixMapping(java.lang.String)
           
 void ignorableWhitespace(char[], int, int)
           
 void parse(InputSource)
          Parse an XML document.
 void parse(java.lang.String)
          Parse an XML document from a system identifier (URI).
 void processingInstruction(java.lang.String, java.lang.String)
           
 void setDocumentHandler(DocumentHandler)
          Allow an application to register a document event handler.
 void setDocumentLocator(Locator)
           
 void setDTDHandler(DTDHandler)
          Allow an application to register a DTD event handler.
 void setEntityResolver(EntityResolver)
          Allow an application to register a custom entity resolver.
 void setErrorHandler(ErrorHandler)
          Allow an application to register an error event handler.
 void setLocale(java.util.Locale)
          Allow an application to request a locale for errors and warnings.
 void skippedEntity(java.lang.String)
           
 void startDocument()
           
 void startElement(java.lang.String, java.lang.String, java.lang.String, Attributes)
           
 void startPrefixMapping(java.lang.String, java.lang.String)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

XMLReaderAdapter

public XMLReaderAdapter()
                 throws SAXException

XMLReaderAdapter

public XMLReaderAdapter(XMLReader)
Method Detail

setLocale

public void setLocale(java.util.Locale)
               throws SAXException
Description copied from interface: Parser
Allow an application to request a locale for errors and warnings.

SAX parsers are not required to provide localisation for errors and warnings; if they cannot support the requested locale, however, they must throw a SAX exception. Applications may not request a locale change in the middle of a parse.

Specified by:
setLocale in interface Parser
Parameters:
- A Java Locale object.
Throws:
SAXException - Throws an exception (using the previous or default locale) if the requested locale is not supported.
See Also:
SAXException, SAXParseException

setEntityResolver

public void setEntityResolver(EntityResolver)
Description copied from interface: Parser
Allow an application to register a custom entity resolver.

If the application does not register an entity resolver, the SAX parser will resolve system identifiers and open connections to entities itself (this is the default behaviour implemented in HandlerBase).

Applications may register a new or different entity resolver in the middle of a parse, and the SAX parser must begin using the new resolver immediately.

Specified by:
setEntityResolver in interface Parser
Parameters:
- The object for resolving entities.
See Also:
EntityResolver, HandlerBase

setDTDHandler

public void setDTDHandler(DTDHandler)
Description copied from interface: Parser
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 (this is the default behaviour implemented by HandlerBase).

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 interface Parser
Parameters:
- The DTD handler.
See Also:
DTDHandler, HandlerBase

setDocumentHandler

public void setDocumentHandler(DocumentHandler)
Description copied from interface: Parser
Allow an application to register a document event handler.

If the application does not register a document handler, all document events reported by the SAX parser will be silently ignored (this is the default behaviour implemented by HandlerBase).

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:
setDocumentHandler in interface Parser
Parameters:
- The document handler.
See Also:
DocumentHandler, HandlerBase

setErrorHandler

public void setErrorHandler(ErrorHandler)
Description copied from interface: Parser
Allow an application to register an error event handler.

If the application does not register an error event handler, all error events reported by the SAX parser will be silently ignored, except for fatalError, which will throw a SAXException (this is the default behaviour implemented by HandlerBase).

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 interface Parser
Parameters:
- The error handler.
See Also:
ErrorHandler, SAXException, HandlerBase

parse

public void parse(java.lang.String)
           throws java.io.IOException,
                  SAXException
Description copied from interface: Parser
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.

Specified by:
parse in interface Parser
Parameters:
- The system identifier (URI).
Throws:
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.
See Also:
Parser.parse(org.xml.sax.InputSource)

parse

public void parse(InputSource)
           throws java.io.IOException,
                  SAXException
Description copied from interface: Parser
Parse an XML document.

The application can use this method to instruct the SAX parser 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 Parser instead for each additional XML document). Once a parse is complete, an application may reuse the same Parser object, possibly with a different input source.

Specified by:
parse in interface Parser
Parameters:
- The input source for the top-level of the XML document.
Throws:
java.io.IOException - An IO exception from the parser, possibly from a byte stream or character stream supplied by the application.
SAXException - Any SAX exception, possibly wrapping another exception.
See Also:
InputSource, Parser.parse(java.lang.String), Parser.setEntityResolver(org.xml.sax.EntityResolver), Parser.setDTDHandler(org.xml.sax.DTDHandler), Parser.setDocumentHandler(org.xml.sax.DocumentHandler), Parser.setErrorHandler(org.xml.sax.ErrorHandler)

setDocumentLocator

public void setDocumentLocator(Locator)
Specified by:
setDocumentLocator in interface ContentHandler

startDocument

public void startDocument()
                   throws SAXException
Specified by:
startDocument in interface ContentHandler
SAXException

endDocument

public void endDocument()
                 throws SAXException
Specified by:
endDocument in interface ContentHandler
SAXException

startPrefixMapping

public void startPrefixMapping(java.lang.String,
                               java.lang.String)
Specified by:
startPrefixMapping in interface ContentHandler

endPrefixMapping

public void endPrefixMapping(java.lang.String)
Specified by:
endPrefixMapping in interface ContentHandler

startElement

public void startElement(java.lang.String,
                         java.lang.String,
                         java.lang.String,
                         Attributes)
                  throws SAXException
Specified by:
startElement in interface ContentHandler
SAXException

endElement

public void endElement(java.lang.String,
                       java.lang.String,
                       java.lang.String)
                throws SAXException
Specified by:
endElement in interface ContentHandler
SAXException

characters

public void characters(char[],
                       int,
                       int)
                throws SAXException
Specified by:
characters in interface ContentHandler
SAXException

ignorableWhitespace

public void ignorableWhitespace(char[],
                                int,
                                int)
                         throws SAXException
Specified by:
ignorableWhitespace in interface ContentHandler
SAXException

processingInstruction

public void processingInstruction(java.lang.String,
                                  java.lang.String)
                           throws SAXException
Specified by:
processingInstruction in interface ContentHandler
SAXException

skippedEntity

public void skippedEntity(java.lang.String)
                   throws SAXException
Specified by:
skippedEntity in interface ContentHandler
SAXException