Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)   
Deprecated in [API level
9](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Ctors](https://developer.android.com/reference/org/xml/sax/HandlerBase#pubctors) \| [Methods](https://developer.android.com/reference/org/xml/sax/HandlerBase#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/org/xml/sax/HandlerBase#inhmethods)

# HandlerBase


`
public


class
HandlerBase
`


`

extends https://developer.android.com/reference/java/lang/Object


`

`


implements

https://developer.android.com/reference/org/xml/sax/DTDHandler,

https://developer.android.com/reference/org/xml/sax/DocumentHandler,

https://developer.android.com/reference/org/xml/sax/EntityResolver,

https://developer.android.com/reference/org/xml/sax/ErrorHandler


`

|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | org.xml.sax.HandlerBase |

<br />

*** ** * ** ***


**This class was deprecated
in API level 9.**   

This class works with the deprecated
`https://developer.android.com/reference/org/xml/sax/DocumentHandler`
interface. It has been replaced by the SAX2
`https://developer.android.com/reference/org/xml/sax/helpers/DefaultHandler`
class.

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 `https://developer.android.com/reference/org/xml/sax/helpers/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.

<br />

**See also:**

- `https://developer.android.com/reference/org/xml/sax/EntityResolver`
- `https://developer.android.com/reference/org/xml/sax/DTDHandler`
- `https://developer.android.com/reference/org/xml/sax/DocumentHandler`
- `https://developer.android.com/reference/org/xml/sax/ErrorHandler`

## Summary

| ### Public constructors ||
|---|---|
| ` https://developer.android.com/reference/org/xml/sax/HandlerBase#HandlerBase()() ` |

| ### Public methods ||
|---|---|
| ` void` | ` https://developer.android.com/reference/org/xml/sax/HandlerBase#characters(char[],%20int,%20int)(char[] ch, int start, int length) ` Receive notification of character data inside an element. |
| ` void` | ` https://developer.android.com/reference/org/xml/sax/HandlerBase#endDocument()() ` Receive notification of the end of the document. |
| ` void` | ` https://developer.android.com/reference/org/xml/sax/HandlerBase#endElement(java.lang.String)(https://developer.android.com/reference/java/lang/String name) ` Receive notification of the end of an element. |
| ` void` | ` https://developer.android.com/reference/org/xml/sax/HandlerBase#error(org.xml.sax.SAXParseException)(https://developer.android.com/reference/org/xml/sax/SAXParseException e) ` Receive notification of a recoverable parser error. |
| ` void` | ` https://developer.android.com/reference/org/xml/sax/HandlerBase#fatalError(org.xml.sax.SAXParseException)(https://developer.android.com/reference/org/xml/sax/SAXParseException e) ` Report a fatal XML parsing error. |
| ` void` | ` https://developer.android.com/reference/org/xml/sax/HandlerBase#ignorableWhitespace(char[],%20int,%20int)(char[] ch, int start, int length) ` Receive notification of ignorable whitespace in element content. |
| ` void` | ` https://developer.android.com/reference/org/xml/sax/HandlerBase#notationDecl(java.lang.String,%20java.lang.String,%20java.lang.String)(https://developer.android.com/reference/java/lang/String name, https://developer.android.com/reference/java/lang/String publicId, https://developer.android.com/reference/java/lang/String systemId) ` Receive notification of a notation declaration. |
| ` void` | ` https://developer.android.com/reference/org/xml/sax/HandlerBase#processingInstruction(java.lang.String,%20java.lang.String)(https://developer.android.com/reference/java/lang/String target, https://developer.android.com/reference/java/lang/String data) ` Receive notification of a processing instruction. |
| ` https://developer.android.com/reference/org/xml/sax/InputSource` | ` https://developer.android.com/reference/org/xml/sax/HandlerBase#resolveEntity(java.lang.String,%20java.lang.String)(https://developer.android.com/reference/java/lang/String publicId, https://developer.android.com/reference/java/lang/String systemId) ` Resolve an external entity. |
| ` void` | ` https://developer.android.com/reference/org/xml/sax/HandlerBase#setDocumentLocator(org.xml.sax.Locator)(https://developer.android.com/reference/org/xml/sax/Locator locator) ` Receive a Locator object for document events. |
| ` void` | ` https://developer.android.com/reference/org/xml/sax/HandlerBase#startDocument()() ` Receive notification of the beginning of the document. |
| ` void` | ` https://developer.android.com/reference/org/xml/sax/HandlerBase#startElement(java.lang.String,%20org.xml.sax.AttributeList)(https://developer.android.com/reference/java/lang/String name, https://developer.android.com/reference/org/xml/sax/AttributeList attributes) ` Receive notification of the start of an element. |
| ` void` | ` https://developer.android.com/reference/org/xml/sax/HandlerBase#unparsedEntityDecl(java.lang.String,%20java.lang.String,%20java.lang.String,%20java.lang.String)(https://developer.android.com/reference/java/lang/String name, https://developer.android.com/reference/java/lang/String publicId, https://developer.android.com/reference/java/lang/String systemId, https://developer.android.com/reference/java/lang/String notationName) ` Receive notification of an unparsed entity declaration. |
| ` void` | ` https://developer.android.com/reference/org/xml/sax/HandlerBase#warning(org.xml.sax.SAXParseException)(https://developer.android.com/reference/org/xml/sax/SAXParseException e) ` Receive notification of a parser warning. |

### Inherited methods

From class `

https://developer.android.com/reference/java/lang/Object

` `


https://developer.android.com/reference/java/lang/Object` `
https://developer.android.com/reference/java/lang/Object#clone()()
`

Creates and returns a copy of this object.


`


boolean` `
https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj)
`

Indicates whether some other object is "equal to" this one.


`


void` `
https://developer.android.com/reference/java/lang/Object#finalize()()
`

Called by the garbage collector on an object when garbage collection
determines that there are no more references to the object.


`


final

https://developer.android.com/reference/java/lang/Class<?>` `
https://developer.android.com/reference/java/lang/Object#getClass()()
`

Returns the runtime class of this `Object`.


`


int` `
https://developer.android.com/reference/java/lang/Object#hashCode()()
`

Returns a hash code value for the object.


`


final

void` `
https://developer.android.com/reference/java/lang/Object#notify()()
`

Wakes up a single thread that is waiting on this object's
monitor.


`


final

void` `
https://developer.android.com/reference/java/lang/Object#notifyAll()()
`

Wakes up all threads that are waiting on this object's monitor.


`


https://developer.android.com/reference/java/lang/String` `
https://developer.android.com/reference/java/lang/Object#toString()()
`

Returns a string representation of the object.


`


final

void` `
https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(long timeoutMillis, int nanos)
`

Causes the current thread to wait until it is awakened, typically
by being *notified* or *interrupted*, or until a
certain amount of real time has elapsed.


`


final

void` `
https://developer.android.com/reference/java/lang/Object#wait(long)(long timeoutMillis)
`

Causes the current thread to wait until it is awakened, typically
by being *notified* or *interrupted*, or until a
certain amount of real time has elapsed.


`


final

void` `
https://developer.android.com/reference/java/lang/Object#wait()()
`

Causes the current thread to wait until it is awakened, typically
by being *notified* or *interrupted*.


From interface `

https://developer.android.com/reference/org/xml/sax/DTDHandler

` `
abstract


void` `
https://developer.android.com/reference/org/xml/sax/DTDHandler#notationDecl(java.lang.String,%20java.lang.String,%20java.lang.String)(https://developer.android.com/reference/java/lang/String name, https://developer.android.com/reference/java/lang/String publicId, https://developer.android.com/reference/java/lang/String systemId)
`

Receive notification of a notation declaration event.


`
abstract


void` `
https://developer.android.com/reference/org/xml/sax/DTDHandler#unparsedEntityDecl(java.lang.String,%20java.lang.String,%20java.lang.String,%20java.lang.String)(https://developer.android.com/reference/java/lang/String name, https://developer.android.com/reference/java/lang/String publicId, https://developer.android.com/reference/java/lang/String systemId, https://developer.android.com/reference/java/lang/String notationName)
`

Receive notification of an unparsed entity declaration event.


From interface `

https://developer.android.com/reference/org/xml/sax/DocumentHandler

` `
abstract


void` `
https://developer.android.com/reference/org/xml/sax/DocumentHandler#characters(char[],%20int,%20int)(char[] ch, int start, int length)
`

Receive notification of character data.


`
abstract


void` `
https://developer.android.com/reference/org/xml/sax/DocumentHandler#endDocument()()
`

Receive notification of the end of a document.


`
abstract


void` `
https://developer.android.com/reference/org/xml/sax/DocumentHandler#endElement(java.lang.String)(https://developer.android.com/reference/java/lang/String name)
`

Receive notification of the end of an element.


`
abstract


void` `
https://developer.android.com/reference/org/xml/sax/DocumentHandler#ignorableWhitespace(char[],%20int,%20int)(char[] ch, int start, int length)
`

Receive notification of ignorable whitespace in element content.


`
abstract


void` `
https://developer.android.com/reference/org/xml/sax/DocumentHandler#processingInstruction(java.lang.String,%20java.lang.String)(https://developer.android.com/reference/java/lang/String target, https://developer.android.com/reference/java/lang/String data)
`

Receive notification of a processing instruction.


`
abstract


void` `
https://developer.android.com/reference/org/xml/sax/DocumentHandler#setDocumentLocator(org.xml.sax.Locator)(https://developer.android.com/reference/org/xml/sax/Locator locator)
`

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


`
abstract


void` `
https://developer.android.com/reference/org/xml/sax/DocumentHandler#startDocument()()
`

Receive notification of the beginning of a document.


`
abstract


void` `
https://developer.android.com/reference/org/xml/sax/DocumentHandler#startElement(java.lang.String,%20org.xml.sax.AttributeList)(https://developer.android.com/reference/java/lang/String name, https://developer.android.com/reference/org/xml/sax/AttributeList atts)
`

Receive notification of the beginning of an element.


From interface `

https://developer.android.com/reference/org/xml/sax/EntityResolver

` `
abstract


https://developer.android.com/reference/org/xml/sax/InputSource` `
https://developer.android.com/reference/org/xml/sax/EntityResolver#resolveEntity(java.lang.String,%20java.lang.String)(https://developer.android.com/reference/java/lang/String publicId, https://developer.android.com/reference/java/lang/String systemId)
`

Allow the application to resolve external entities.


From interface `

https://developer.android.com/reference/org/xml/sax/ErrorHandler

` `
abstract


void` `
https://developer.android.com/reference/org/xml/sax/ErrorHandler#error(org.xml.sax.SAXParseException)(https://developer.android.com/reference/org/xml/sax/SAXParseException exception)
`

Receive notification of a recoverable error.


`
abstract


void` `
https://developer.android.com/reference/org/xml/sax/ErrorHandler#fatalError(org.xml.sax.SAXParseException)(https://developer.android.com/reference/org/xml/sax/SAXParseException exception)
`

Receive notification of a non-recoverable error.


`
abstract


void` `
https://developer.android.com/reference/org/xml/sax/ErrorHandler#warning(org.xml.sax.SAXParseException)(https://developer.android.com/reference/org/xml/sax/SAXParseException exception)
`

Receive notification of a warning.


## Public constructors

### HandlerBase

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public HandlerBase ()
```

<br />

<br />

## Public methods

### characters

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void characters (char[] ch, 
                int start, 
                int length)
```

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).

<br />

<br />

| Parameters ||
|---|---|
| `ch` | `char`: The characters. <br /> |
| `start` | `int`: The start position in the character array. <br /> |
| `length` | `int`: The number of characters to use from the character array. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/org/xml/sax/SAXException` | Any SAX exception, possibly wrapping another exception. |

**See also:**

- `https://developer.android.com/reference/org/xml/sax/DocumentHandler#characters(char[],%20int,%20int)`

### endDocument

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void endDocument ()
```

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 beginning
of a document (such as finalising a tree or closing an output
file).

<br />

<br />

| Throws ||
|---|---|
| `https://developer.android.com/reference/org/xml/sax/SAXException` | Any SAX exception, possibly wrapping another exception. |

**See also:**

- `https://developer.android.com/reference/org/xml/sax/DocumentHandler#endDocument()`

### endElement

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void endElement (String name)
```

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).

<br />

<br />

| Parameters ||
|---|---|
| `name` | `String`: the element name <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/org/xml/sax/SAXException` | Any SAX exception, possibly wrapping another exception. |

**See also:**

- `https://developer.android.com/reference/org/xml/sax/DocumentHandler#endElement(java.lang.String)`

### error

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void error (SAXParseException e)
```

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.

<br />

<br />

| Parameters ||
|---|---|
| `e` | `SAXParseException`: The warning information encoded as an exception. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/org/xml/sax/SAXException` | Any SAX exception, possibly wrapping another exception. |

**See also:**

- `https://developer.android.com/reference/org/xml/sax/ErrorHandler#warning(org.xml.sax.SAXParseException)`
- `https://developer.android.com/reference/org/xml/sax/SAXParseException`

### fatalError

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void fatalError (SAXParseException e)
```

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.

<br />

<br />

| Parameters ||
|---|---|
| `e` | `SAXParseException`: The error information encoded as an exception. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/org/xml/sax/SAXException` | Any SAX exception, possibly wrapping another exception. |

**See also:**

- `https://developer.android.com/reference/org/xml/sax/ErrorHandler#fatalError(org.xml.sax.SAXParseException)`
- `https://developer.android.com/reference/org/xml/sax/SAXParseException`

### ignorableWhitespace

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void ignorableWhitespace (char[] ch, 
                int start, 
                int length)
```

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).

<br />

<br />

| Parameters ||
|---|---|
| `ch` | `char`: The whitespace characters. <br /> |
| `start` | `int`: The start position in the character array. <br /> |
| `length` | `int`: The number of characters to use from the character array. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/org/xml/sax/SAXException` | Any SAX exception, possibly wrapping another exception. |

**See also:**

- `https://developer.android.com/reference/org/xml/sax/DocumentHandler#ignorableWhitespace(char[],%20int,%20int)`

### notationDecl

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void notationDecl (String name, 
                String publicId, 
                String systemId)
```

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.

<br />

<br />

| Parameters ||
|---|---|
| `name` | `String`: The notation name. <br /> |
| `publicId` | `String`: The notation public identifier, or null if not available. <br /> |
| `systemId` | `String`: The notation system identifier. <br /> |

**See also:**

- `https://developer.android.com/reference/org/xml/sax/DTDHandler#notationDecl(java.lang.String,%20java.lang.String,%20java.lang.String)`

### processingInstruction

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void processingInstruction (String target, 
                String data)
```

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.

<br />

<br />

| Parameters ||
|---|---|
| `target` | `String`: The processing instruction target. <br /> |
| `data` | `String`: The processing instruction data, or null if none is supplied. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/org/xml/sax/SAXException` | Any SAX exception, possibly wrapping another exception. |

**See also:**

- `https://developer.android.com/reference/org/xml/sax/DocumentHandler#processingInstruction(java.lang.String,%20java.lang.String)`

### resolveEntity

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public InputSource resolveEntity (String publicId, 
                String systemId)
```

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.

<br />

<br />

| Parameters ||
|---|---|
| `publicId` | `String`: The public identifier, or null if none is available. <br /> |
| `systemId` | `String`: The system identifier provided in the XML document. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/org/xml/sax/InputSource` | The new input source, or null to require the default behaviour. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/org/xml/sax/SAXException` | Any SAX exception, possibly wrapping another exception. |

**See also:**

- `https://developer.android.com/reference/org/xml/sax/EntityResolver#resolveEntity(java.lang.String,%20java.lang.String)`

### setDocumentLocator

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void setDocumentLocator (Locator locator)
```

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.

<br />

<br />

| Parameters ||
|---|---|
| `locator` | `Locator`: A locator for all SAX document events. <br /> |

**See also:**

- `https://developer.android.com/reference/org/xml/sax/DocumentHandler#setDocumentLocator(org.xml.sax.Locator)`
- `https://developer.android.com/reference/org/xml/sax/Locator`

### startDocument

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void startDocument ()
```

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).

<br />

<br />

| Throws ||
|---|---|
| `https://developer.android.com/reference/org/xml/sax/SAXException` | Any SAX exception, possibly wrapping another exception. |

**See also:**

- `https://developer.android.com/reference/org/xml/sax/DocumentHandler#startDocument()`

### startElement

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void startElement (String name, 
                AttributeList attributes)
```

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).

<br />

<br />

| Parameters ||
|---|---|
| `name` | `String`: The element type name. <br /> |
| `attributes` | `AttributeList`: The specified or defaulted attributes. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/org/xml/sax/SAXException` | Any SAX exception, possibly wrapping another exception. |

**See also:**

- `https://developer.android.com/reference/org/xml/sax/DocumentHandler#startElement(java.lang.String,%20org.xml.sax.AttributeList)`

### unparsedEntityDecl

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void unparsedEntityDecl (String name, 
                String publicId, 
                String systemId, 
                String notationName)
```

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.

<br />

<br />

| Parameters ||
|---|---|
| `name` | `String`: The entity name. <br /> |
| `publicId` | `String`: The entity public identifier, or null if not available. <br /> |
| `systemId` | `String`: The entity system identifier. <br /> |
| `notationName` | `String`: The name of the associated notation. <br /> |

**See also:**

- `https://developer.android.com/reference/org/xml/sax/DTDHandler#unparsedEntityDecl(java.lang.String,%20java.lang.String,%20java.lang.String,%20java.lang.String)`

### warning

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void warning (SAXParseException e)
```

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.

<br />

<br />

| Parameters ||
|---|---|
| `e` | `SAXParseException`: The warning information encoded as an exception. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/org/xml/sax/SAXException` | Any SAX exception, possibly wrapping another exception. |

**See also:**

- `https://developer.android.com/reference/org/xml/sax/ErrorHandler#warning(org.xml.sax.SAXParseException)`
- `https://developer.android.com/reference/org/xml/sax/SAXParseException`