org.xml.sax.helpers
Class ParserAdapter

java.lang.Object
  |
  +--org.xml.sax.helpers.ParserAdapter

All Implemented Interfaces:

DocumentHandler, XMLReader

public synchronized class ParserAdapter

extends java.lang.Object

implements XMLReader, DocumentHandler

Constructor Summary

ParserAdapter()

ParserAdapter(Parser)

Method Summary

void	characters(char[], int, int) Receive notification of character data.
void	endDocument() Receive notification of the end of a document.
void	endElement(java.lang.String) Receive notification of the end of an element.
ContentHandler	getContentHandler()
DTDHandler	getDTDHandler()
EntityResolver	getEntityResolver()
ErrorHandler	getErrorHandler()
boolean	getFeature(java.lang.String)
java.lang.Object	getProperty(java.lang.String)
void	ignorableWhitespace(char[], int, int) Receive notification of ignorable whitespace in element content.
void	parse(InputSource)
void	parse(java.lang.String)
void	processingInstruction(java.lang.String, java.lang.String) Receive notification of a processing instruction.
void	setContentHandler(ContentHandler)
void	setDocumentLocator(Locator) Receive an object for locating the origin of SAX document events.
void	setDTDHandler(DTDHandler)
void	setEntityResolver(EntityResolver)
void	setErrorHandler(ErrorHandler)
void	setFeature(java.lang.String, boolean)
void	setProperty(java.lang.String, java.lang.Object)
void	startDocument() Receive notification of the beginning of a document.
void	startElement(java.lang.String, AttributeList) Receive notification of the beginning of an element.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ParserAdapter

public ParserAdapter()
              throws SAXException

ParserAdapter

public ParserAdapter(Parser)

Method Detail

setFeature

public void setFeature(java.lang.String,
                       boolean)
                throws SAXNotRecognizedException,
                       SAXNotSupportedException

Specified by:

setFeature in interface XMLReader

SAXNotRecognizedException

SAXNotSupportedException

getFeature

public boolean getFeature(java.lang.String)
                   throws SAXNotRecognizedException,
                          SAXNotSupportedException

Specified by:

getFeature in interface XMLReader

SAXNotRecognizedException

SAXNotSupportedException

setProperty

public void setProperty(java.lang.String,
                        java.lang.Object)
                 throws SAXNotRecognizedException,
                        SAXNotSupportedException

Specified by:

setProperty in interface XMLReader

SAXNotRecognizedException

SAXNotSupportedException

getProperty

public java.lang.Object getProperty(java.lang.String)
                             throws SAXNotRecognizedException,
                                    SAXNotSupportedException

Specified by:

getProperty in interface XMLReader

SAXNotRecognizedException

SAXNotSupportedException

setEntityResolver

public void setEntityResolver(EntityResolver)

Specified by:

setEntityResolver in interface XMLReader

getEntityResolver

public EntityResolver getEntityResolver()

Specified by:

getEntityResolver in interface XMLReader

setDTDHandler

public void setDTDHandler(DTDHandler)

Specified by:

setDTDHandler in interface XMLReader

getDTDHandler

public DTDHandler getDTDHandler()

Specified by:

getDTDHandler in interface XMLReader

setContentHandler

public void setContentHandler(ContentHandler)

Specified by:

setContentHandler in interface XMLReader

getContentHandler

public ContentHandler getContentHandler()

Specified by:

getContentHandler in interface XMLReader

setErrorHandler

public void setErrorHandler(ErrorHandler)

Specified by:

setErrorHandler in interface XMLReader

getErrorHandler

public ErrorHandler getErrorHandler()

Specified by:

getErrorHandler in interface XMLReader

parse

public void parse(java.lang.String)
           throws java.io.IOException,
                  SAXException

Specified by:

parse in interface XMLReader

java.io.IOException

SAXException

parse

public void parse(InputSource)
           throws java.io.IOException,
                  SAXException

Specified by:

parse in interface XMLReader

java.io.IOException

SAXException

setDocumentLocator

public void setDocumentLocator(Locator)

Description copied from interface: DocumentHandler

Receive an object for locating the origin of SAX document events.

SAX parsers are strongly encouraged (though not absolutely required) to supply a locator: if it does so, it must supply the locator to the application by invoking this method before invoking any of the other methods in the DocumentHandler interface.

The locator allows the application to determine the end position of any document-related event, even if the parser is not reporting an error. Typically, the application will use this information for reporting its own errors (such as character content that does not match an application's business rules). The information returned by the locator is probably not sufficient for use with a search engine.

Note that the locator will return correct information only during the invocation of the events in this interface. The application should not attempt to use it at any other time.

Specified by:

setDocumentLocator in interface DocumentHandler

Parameters:

- An object that can return the location of any SAX document event.

See Also:

Locator

startDocument

public void startDocument()
                   throws SAXException

Description copied from interface: DocumentHandler

Receive notification of the beginning of a document.

The SAX parser will invoke this method only once, before any other methods in this interface or in DTDHandler (except for setDocumentLocator).

Specified by:

startDocument in interface DocumentHandler

Throws:

SAXException - Any SAX exception, possibly wrapping another exception.

endDocument

public void endDocument()
                 throws SAXException

Description copied from interface: DocumentHandler

Receive notification of the end of a document.

The SAX parser will invoke this method only once, and it will be the last method invoked during the parse. The parser shall not invoke this method until it has either abandoned parsing (because of an unrecoverable error) or reached the end of input.

Specified by:

endDocument in interface DocumentHandler

Throws:

SAXException - Any SAX exception, possibly wrapping another exception.

startElement

public void startElement(java.lang.String,
                         AttributeList)
                  throws SAXException

Description copied from interface: DocumentHandler

Receive notification of the beginning of an element.

The Parser will invoke this method at the beginning of every element in the XML document; there will be a corresponding endElement() event for every startElement() event (even when the element is empty). All of the element's content will be reported, in order, before the corresponding endElement() event.

If the element name has a namespace prefix, the prefix will still be attached. Note that the attribute list provided will contain only attributes with explicit values (specified or defaulted): #IMPLIED attributes will be omitted.

Specified by:

startElement in interface DocumentHandler

Parameters:

- The element type name.

- The attributes attached to the element, if any.

Throws:

SAXException - Any SAX exception, possibly wrapping another exception.

See Also:

DocumentHandler.endElement(java.lang.String), AttributeList

endElement

public void endElement(java.lang.String)
                throws SAXException

Description copied from interface: DocumentHandler

Receive notification of the end of an element.

The SAX parser will invoke this method at the end of every element in the XML document; there will be a corresponding startElement() event for every endElement() event (even when the element is empty).

If the element name has a namespace prefix, the prefix will still be attached to the name.

Specified by:

endElement in interface DocumentHandler

Parameters:

- The element type name

Throws:

SAXException - Any SAX exception, possibly wrapping another exception.

characters

public void characters(char[],
                       int,
                       int)
                throws SAXException

Description copied from interface: DocumentHandler

Receive notification of character data.

The Parser will call this method to report each chunk of character data. SAX parsers may return all contiguous character data in a single chunk, or they may split it into several chunks; however, all of the characters in any single event must come from the same external entity, so that the Locator provides useful information.

The application must not attempt to read from the array outside of the specified range.

Note that some parsers will report whitespace using the ignorableWhitespace() method rather than this one (validating parsers must do so).

Specified by:

characters in interface DocumentHandler

Parameters:

- The characters from the XML document.

- The start position in the array.

- The number of characters to read from the array.

Throws:

SAXException - Any SAX exception, possibly wrapping another exception.

See Also:

DocumentHandler.ignorableWhitespace(char[], int, int), Locator

ignorableWhitespace

public void ignorableWhitespace(char[],
                                int,
                                int)
                         throws SAXException

Description copied from interface: DocumentHandler

Receive notification of ignorable whitespace in element content.

Validating Parsers must use this method to report each chunk of ignorable whitespace (see the W3C XML 1.0 recommendation, section 2.10): non-validating parsers may also use this method if they are capable of parsing and using content models.

SAX parsers may return all contiguous whitespace in a single chunk, or they may split it into several chunks; however, all of the characters in any single event must come from the same external entity, so that the Locator provides useful information.

The application must not attempt to read from the array outside of the specified range.

Specified by:

ignorableWhitespace in interface DocumentHandler

Parameters:

- The characters from the XML document.

- The start position in the array.

- The number of characters to read from the array.

Throws:

SAXException - Any SAX exception, possibly wrapping another exception.

See Also:

DocumentHandler.characters(char[], int, int)

processingInstruction

public void processingInstruction(java.lang.String,
                                  java.lang.String)
                           throws SAXException

Description copied from interface: DocumentHandler

Receive notification of a processing instruction.

The Parser will invoke this method once for each processing instruction found: note that processing instructions may occur before or after the main document element.

A SAX parser should never report an XML declaration (XML 1.0, section 2.8) or a text declaration (XML 1.0, section 4.3.1) using this method.

Specified by:

processingInstruction in interface DocumentHandler

Parameters:

- The processing instruction target.

- The processing instruction data, or null if none was supplied.

Throws:

SAXException - Any SAX exception, possibly wrapping another exception.