HandlerBase (Java Platform SE 7 ) (original) (raw)

java.lang.Object
- org.xml.sax.HandlerBase
All Implemented Interfaces:
DocumentHandler, DTDHandler, EntityResolver, ErrorHandler

public class HandlerBase
extends Object
implements EntityResolver, DTDHandler, DocumentHandler, ErrorHandler
Default base class for handlers.

This module, both source code and documentation, is in the Public Domain, and comes with NO WARRANTY. See http://www.saxproject.org for further information.
This class implements the default behaviour for four SAX1 interfaces: EntityResolver, DTDHandler, DocumentHandler, and ErrorHandler. It is now obsolete, but is included in SAX2 to support legacy SAX1 applications. SAX2 applications should use the DefaultHandler class instead.
Application writers can extend this class when they need to implement only part of an interface; parser writers can instantiate this class to provide default handlers when the application has not supplied its own.
Note that the use of this class is optional.
Since:
SAX 1.0
See Also:
EntityResolver, DTDHandler, DocumentHandler, ErrorHandler

Constructor Summary

Constructors

Constructor and Description
HandlerBase() Deprecated.

Method Summary

Methods

Modifier and Type	Method and Description
void	characters(char[] ch, int start, int length) Deprecated. Receive notification of character data inside an element.
void	endDocument() Deprecated. Receive notification of the end of the document.
void	endElement(String name) Deprecated. Receive notification of the end of an element.
void	error(SAXParseException e) Deprecated. Receive notification of a recoverable parser error.
void	fatalError(SAXParseException e) Deprecated. Report a fatal XML parsing error.
void	ignorableWhitespace(char[] ch, int start, int length) Deprecated. Receive notification of ignorable whitespace in element content.
void	notationDecl(String name,String publicId,String systemId) Deprecated. Receive notification of a notation declaration.
void	processingInstruction(String target,String data) Deprecated. Receive notification of a processing instruction.
InputSource	resolveEntity(String publicId,String systemId) Deprecated. Resolve an external entity.
void	setDocumentLocator(Locator locator) Deprecated. Receive a Locator object for document events.
void	startDocument() Deprecated. Receive notification of the beginning of the document.
void	startElement(String name,AttributeList attributes) Deprecated. Receive notification of the start of an element.
void	unparsedEntityDecl(String name,String publicId,String systemId,String notationName) Deprecated. Receive notification of an unparsed entity declaration.
void	warning(SAXParseException e) Deprecated. Receive notification of a parser warning.

   * ### Methods inherited from class java.lang.[Object](../../../java/lang/Object.html "class in java.lang")  
   `[clone](../../../java/lang/Object.html#clone%28%29), [equals](../../../java/lang/Object.html#equals%28java.lang.Object%29), [finalize](../../../java/lang/Object.html#finalize%28%29), [getClass](../../../java/lang/Object.html#getClass%28%29), [hashCode](../../../java/lang/Object.html#hashCode%28%29), [notify](../../../java/lang/Object.html#notify%28%29), [notifyAll](../../../java/lang/Object.html#notifyAll%28%29), [toString](../../../java/lang/Object.html#toString%28%29), [wait](../../../java/lang/Object.html#wait%28%29), [wait](../../../java/lang/Object.html#wait%28long%29), [wait](../../../java/lang/Object.html#wait%28long,%20int%29)`

Constructor Detail

 * #### HandlerBase  
 public HandlerBase()  
 Deprecated.

Method Detail

* #### resolveEntity  
public [InputSource](../../../org/xml/sax/InputSource.html "class in org.xml.sax") resolveEntity([String](../../../java/lang/String.html "class in java.lang") publicId,  
                        [String](../../../java/lang/String.html "class in java.lang") systemId)  
                          throws [SAXException](../../../org/xml/sax/SAXException.html "class in org.xml.sax")  
Deprecated.  
Resolve an external entity.  
Always return null, so that the parser will use the system identifier provided in the XML document. This method implements the SAX default behaviour: application writers can override it in a subclass to do special translations such as catalog lookups or URI redirection.  
**Specified by:**  
`[resolveEntity](../../../org/xml/sax/EntityResolver.html#resolveEntity%28java.lang.String,%20java.lang.String%29)` in interface `[EntityResolver](../../../org/xml/sax/EntityResolver.html "interface in org.xml.sax")`  
Parameters:  
`publicId` \- The public identifer, or null if none is available.  
`systemId` \- The system identifier provided in the XML document.  
Returns:  
The new input source, or null to require the default behaviour.  
Throws:  
`[SAXException](../../../org/xml/sax/SAXException.html "class in org.xml.sax")` \- Any SAX exception, possibly wrapping another exception.  
See Also:  
[EntityResolver.resolveEntity(java.lang.String, java.lang.String)](../../../org/xml/sax/EntityResolver.html#resolveEntity%28java.lang.String,%20java.lang.String%29)  
* #### notationDecl  
public void notationDecl([String](../../../java/lang/String.html "class in java.lang") name,  
                [String](../../../java/lang/String.html "class in java.lang") publicId,  
                [String](../../../java/lang/String.html "class in java.lang") systemId)  
Deprecated.  
Receive notification of a notation declaration.  
By default, do nothing. Application writers may override this method in a subclass if they wish to keep track of the notations declared in a document.  
**Specified by:**  
`[notationDecl](../../../org/xml/sax/DTDHandler.html#notationDecl%28java.lang.String,%20java.lang.String,%20java.lang.String%29)` in interface `[DTDHandler](../../../org/xml/sax/DTDHandler.html "interface in org.xml.sax")`  
Parameters:  
`name` \- The notation name.  
`publicId` \- The notation public identifier, or null if not available.  
`systemId` \- The notation system identifier.  
See Also:  
[DTDHandler.notationDecl(java.lang.String, java.lang.String, java.lang.String)](../../../org/xml/sax/DTDHandler.html#notationDecl%28java.lang.String,%20java.lang.String,%20java.lang.String%29)  
* #### unparsedEntityDecl  
public void unparsedEntityDecl([String](../../../java/lang/String.html "class in java.lang") name,  
                      [String](../../../java/lang/String.html "class in java.lang") publicId,  
                      [String](../../../java/lang/String.html "class in java.lang") systemId,  
                      [String](../../../java/lang/String.html "class in java.lang") notationName)  
Deprecated.  
Receive notification of an unparsed entity declaration.  
By default, do nothing. Application writers may override this method in a subclass to keep track of the unparsed entities declared in a document.  
**Specified by:**  
`[unparsedEntityDecl](../../../org/xml/sax/DTDHandler.html#unparsedEntityDecl%28java.lang.String,%20java.lang.String,%20java.lang.String,%20java.lang.String%29)` in interface `[DTDHandler](../../../org/xml/sax/DTDHandler.html "interface in org.xml.sax")`  
Parameters:  
`name` \- The entity name.  
`publicId` \- The entity public identifier, or null if not available.  
`systemId` \- The entity system identifier.  
`notationName` \- The name of the associated notation.  
See Also:  
[DTDHandler.unparsedEntityDecl(java.lang.String, java.lang.String, java.lang.String, java.lang.String)](../../../org/xml/sax/DTDHandler.html#unparsedEntityDecl%28java.lang.String,%20java.lang.String,%20java.lang.String,%20java.lang.String%29)  
* #### setDocumentLocator  
public void setDocumentLocator([Locator](../../../org/xml/sax/Locator.html "interface in org.xml.sax") locator)  
Deprecated.  
Receive a Locator object for document events.  
By default, do nothing. Application writers may override this method in a subclass if they wish to store the locator for use with other document events.  
**Specified by:**  
`[setDocumentLocator](../../../org/xml/sax/DocumentHandler.html#setDocumentLocator%28org.xml.sax.Locator%29)` in interface `[DocumentHandler](../../../org/xml/sax/DocumentHandler.html "interface in org.xml.sax")`  
Parameters:  
`locator` \- A locator for all SAX document events.  
See Also:  
[DocumentHandler.setDocumentLocator(org.xml.sax.Locator)](../../../org/xml/sax/DocumentHandler.html#setDocumentLocator%28org.xml.sax.Locator%29), [Locator](../../../org/xml/sax/Locator.html "interface in org.xml.sax")  
* #### startDocument  
public void startDocument()  
                   throws [SAXException](../../../org/xml/sax/SAXException.html "class in org.xml.sax")  
Deprecated.  
Receive notification of the beginning of the document.  
By default, do nothing. Application writers may override this method in a subclass to take specific actions at the beginning of a document (such as allocating the root node of a tree or creating an output file).  
**Specified by:**  
`[startDocument](../../../org/xml/sax/DocumentHandler.html#startDocument%28%29)` in interface `[DocumentHandler](../../../org/xml/sax/DocumentHandler.html "interface in org.xml.sax")`  
Throws:  
`[SAXException](../../../org/xml/sax/SAXException.html "class in org.xml.sax")` \- Any SAX exception, possibly wrapping another exception.  
See Also:  
[DocumentHandler.startDocument()](../../../org/xml/sax/DocumentHandler.html#startDocument%28%29)  
* #### endDocument  
public void endDocument()  
                 throws [SAXException](../../../org/xml/sax/SAXException.html "class in org.xml.sax")  
Deprecated.  
Receive notification of the end of the document.  
By default, do nothing. Application writers may override this method in a subclass to take specific actions at the end of a document (such as finalising a tree or closing an output file).  
**Specified by:**  
`[endDocument](../../../org/xml/sax/DocumentHandler.html#endDocument%28%29)` in interface `[DocumentHandler](../../../org/xml/sax/DocumentHandler.html "interface in org.xml.sax")`  
Throws:  
`[SAXException](../../../org/xml/sax/SAXException.html "class in org.xml.sax")` \- Any SAX exception, possibly wrapping another exception.  
See Also:  
[DocumentHandler.endDocument()](../../../org/xml/sax/DocumentHandler.html#endDocument%28%29)  
* #### startElement  
public void startElement([String](../../../java/lang/String.html "class in java.lang") name,  
                [AttributeList](../../../org/xml/sax/AttributeList.html "interface in org.xml.sax") attributes)  
                  throws [SAXException](../../../org/xml/sax/SAXException.html "class in org.xml.sax")  
Deprecated.  
Receive notification of the start of an element.  
By default, do nothing. Application writers may override this method in a subclass to take specific actions at the start of each element (such as allocating a new tree node or writing output to a file).  
**Specified by:**  
`[startElement](../../../org/xml/sax/DocumentHandler.html#startElement%28java.lang.String,%20org.xml.sax.AttributeList%29)` in interface `[DocumentHandler](../../../org/xml/sax/DocumentHandler.html "interface in org.xml.sax")`  
Parameters:  
`name` \- The element type name.  
`attributes` \- The specified or defaulted attributes.  
Throws:  
`[SAXException](../../../org/xml/sax/SAXException.html "class in org.xml.sax")` \- Any SAX exception, possibly wrapping another exception.  
See Also:  
[DocumentHandler.startElement(java.lang.String, org.xml.sax.AttributeList)](../../../org/xml/sax/DocumentHandler.html#startElement%28java.lang.String,%20org.xml.sax.AttributeList%29)  
* #### endElement  
public void endElement([String](../../../java/lang/String.html "class in java.lang") name)  
                throws [SAXException](../../../org/xml/sax/SAXException.html "class in org.xml.sax")  
Deprecated.  
Receive notification of the end of an element.  
By default, do nothing. Application writers may override this method in a subclass to take specific actions at the end of each element (such as finalising a tree node or writing output to a file).  
**Specified by:**  
`[endElement](../../../org/xml/sax/DocumentHandler.html#endElement%28java.lang.String%29)` in interface `[DocumentHandler](../../../org/xml/sax/DocumentHandler.html "interface in org.xml.sax")`  
Parameters:  
`name` \- the element name  
Throws:  
`[SAXException](../../../org/xml/sax/SAXException.html "class in org.xml.sax")` \- Any SAX exception, possibly wrapping another exception.  
See Also:  
[DocumentHandler.endElement(java.lang.String)](../../../org/xml/sax/DocumentHandler.html#endElement%28java.lang.String%29)  
* #### characters  
public void characters(char[] ch,  
              int start,  
              int length)  
                throws [SAXException](../../../org/xml/sax/SAXException.html "class in org.xml.sax")  
Deprecated.  
Receive notification of character data inside an element.  
By default, do nothing. Application writers may override this method to take specific actions for each chunk of character data (such as adding the data to a node or buffer, or printing it to a file).  
**Specified by:**  
`[characters](../../../org/xml/sax/DocumentHandler.html#characters%28char[],%20int,%20int%29)` in interface `[DocumentHandler](../../../org/xml/sax/DocumentHandler.html "interface in org.xml.sax")`  
Parameters:  
`ch` \- The characters.  
`start` \- The start position in the character array.  
`length` \- The number of characters to use from the character array.  
Throws:  
`[SAXException](../../../org/xml/sax/SAXException.html "class in org.xml.sax")` \- Any SAX exception, possibly wrapping another exception.  
See Also:  
[DocumentHandler.characters(char\[\], int, int)](../../../org/xml/sax/DocumentHandler.html#characters%28char[],%20int,%20int%29)  
* #### ignorableWhitespace  
public void ignorableWhitespace(char[] ch,  
                       int start,  
                       int length)  
                         throws [SAXException](../../../org/xml/sax/SAXException.html "class in org.xml.sax")  
Deprecated.  
Receive notification of ignorable whitespace in element content.  
By default, do nothing. Application writers may override this method to take specific actions for each chunk of ignorable whitespace (such as adding data to a node or buffer, or printing it to a file).  
**Specified by:**  
`[ignorableWhitespace](../../../org/xml/sax/DocumentHandler.html#ignorableWhitespace%28char[],%20int,%20int%29)` in interface `[DocumentHandler](../../../org/xml/sax/DocumentHandler.html "interface in org.xml.sax")`  
Parameters:  
`ch` \- The whitespace characters.  
`start` \- The start position in the character array.  
`length` \- The number of characters to use from the character array.  
Throws:  
`[SAXException](../../../org/xml/sax/SAXException.html "class in org.xml.sax")` \- Any SAX exception, possibly wrapping another exception.  
See Also:  
[DocumentHandler.ignorableWhitespace(char\[\], int, int)](../../../org/xml/sax/DocumentHandler.html#ignorableWhitespace%28char[],%20int,%20int%29)  
* #### processingInstruction  
public void processingInstruction([String](../../../java/lang/String.html "class in java.lang") target,  
                         [String](../../../java/lang/String.html "class in java.lang") data)  
                           throws [SAXException](../../../org/xml/sax/SAXException.html "class in org.xml.sax")  
Deprecated.  
Receive notification of a processing instruction.  
By default, do nothing. Application writers may override this method in a subclass to take specific actions for each processing instruction, such as setting status variables or invoking other methods.  
**Specified by:**  
`[processingInstruction](../../../org/xml/sax/DocumentHandler.html#processingInstruction%28java.lang.String,%20java.lang.String%29)` in interface `[DocumentHandler](../../../org/xml/sax/DocumentHandler.html "interface in org.xml.sax")`  
Parameters:  
`target` \- The processing instruction target.  
`data` \- The processing instruction data, or null if none is supplied.  
Throws:  
`[SAXException](../../../org/xml/sax/SAXException.html "class in org.xml.sax")` \- Any SAX exception, possibly wrapping another exception.  
See Also:  
[DocumentHandler.processingInstruction(java.lang.String, java.lang.String)](../../../org/xml/sax/DocumentHandler.html#processingInstruction%28java.lang.String,%20java.lang.String%29)  
* #### warning  
public void warning([SAXParseException](../../../org/xml/sax/SAXParseException.html "class in org.xml.sax") e)  
             throws [SAXException](../../../org/xml/sax/SAXException.html "class in org.xml.sax")  
Deprecated.  
Receive notification of a parser warning.  
The default implementation does nothing. Application writers may override this method in a subclass to take specific actions for each warning, such as inserting the message in a log file or printing it to the console.  
**Specified by:**  
`[warning](../../../org/xml/sax/ErrorHandler.html#warning%28org.xml.sax.SAXParseException%29)` in interface `[ErrorHandler](../../../org/xml/sax/ErrorHandler.html "interface in org.xml.sax")`  
Parameters:  
`e` \- The warning information encoded as an exception.  
Throws:  
`[SAXException](../../../org/xml/sax/SAXException.html "class in org.xml.sax")` \- Any SAX exception, possibly wrapping another exception.  
See Also:  
[ErrorHandler.warning(org.xml.sax.SAXParseException)](../../../org/xml/sax/ErrorHandler.html#warning%28org.xml.sax.SAXParseException%29), [SAXParseException](../../../org/xml/sax/SAXParseException.html "class in org.xml.sax")  
* #### error  
public void error([SAXParseException](../../../org/xml/sax/SAXParseException.html "class in org.xml.sax") e)  
           throws [SAXException](../../../org/xml/sax/SAXException.html "class in org.xml.sax")  
Deprecated.  
Receive notification of a recoverable parser error.  
The default implementation does nothing. Application writers may override this method in a subclass to take specific actions for each error, such as inserting the message in a log file or printing it to the console.  
**Specified by:**  
`[error](../../../org/xml/sax/ErrorHandler.html#error%28org.xml.sax.SAXParseException%29)` in interface `[ErrorHandler](../../../org/xml/sax/ErrorHandler.html "interface in org.xml.sax")`  
Parameters:  
`e` \- The warning information encoded as an exception.  
Throws:  
`[SAXException](../../../org/xml/sax/SAXException.html "class in org.xml.sax")` \- Any SAX exception, possibly wrapping another exception.  
See Also:  
[ErrorHandler.warning(org.xml.sax.SAXParseException)](../../../org/xml/sax/ErrorHandler.html#warning%28org.xml.sax.SAXParseException%29), [SAXParseException](../../../org/xml/sax/SAXParseException.html "class in org.xml.sax")  
* #### fatalError  
public void fatalError([SAXParseException](../../../org/xml/sax/SAXParseException.html "class in org.xml.sax") e)  
                throws [SAXException](../../../org/xml/sax/SAXException.html "class in org.xml.sax")  
Deprecated.  
Report a fatal XML parsing error.  
The default implementation throws a SAXParseException. Application writers may override this method in a subclass if they need to take specific actions for each fatal error (such as collecting all of the errors into a single report): in any case, the application must stop all regular processing when this method is invoked, since the document is no longer reliable, and the parser may no longer report parsing events.  
**Specified by:**  
`[fatalError](../../../org/xml/sax/ErrorHandler.html#fatalError%28org.xml.sax.SAXParseException%29)` in interface `[ErrorHandler](../../../org/xml/sax/ErrorHandler.html "interface in org.xml.sax")`  
Parameters:  
`e` \- The error information encoded as an exception.  
Throws:  
`[SAXException](../../../org/xml/sax/SAXException.html "class in org.xml.sax")` \- Any SAX exception, possibly wrapping another exception.  
See Also:  
[ErrorHandler.fatalError(org.xml.sax.SAXParseException)](../../../org/xml/sax/ErrorHandler.html#fatalError%28org.xml.sax.SAXParseException%29), [SAXParseException](../../../org/xml/sax/SAXParseException.html "class in org.xml.sax")

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2020, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.

HandlerBase (Java Platform SE 7 ) (original) (raw)

Constructor Summary

Method Summary

Constructor Detail

Method Detail