HandlerBase
open classHandlerBase: DTDHandler, DocumentHandler, EntityResolver, ErrorHandler
kotlin.Any | |
↳ | org.xml.sax.HandlerBase |
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.
Summary
Public constructors | |
---|---|
Public methods | |
---|---|
open Unit |
characters(ch: CharArray!, start: Int, length: Int) Receive notification of character data inside an element. |
open Unit |
Receive notification of the end of the document. |
open Unit |
endElement(name: String!) Receive notification of the end of an element. |
open Unit |
error(e: SAXParseException!) Receive notification of a recoverable parser error. |
open Unit |
Report a fatal XML parsing error. |
open Unit |
ignorableWhitespace(ch: CharArray!, start: Int, length: Int) Receive notification of ignorable whitespace in element content. |
open Unit |
notationDecl(name: String!, publicId: String!, systemId: String!) Receive notification of a notation declaration. |
open Unit |
processingInstruction(target: String!, data: String!) Receive notification of a processing instruction. |
open InputSource! |
resolveEntity(publicId: String!, systemId: String!) Resolve an external entity. |
open Unit |
setDocumentLocator(locator: Locator!) Receive a Locator object for document events. |
open Unit |
Receive notification of the beginning of the document. |
open Unit |
startElement(name: String!, attributes: AttributeList!) Receive notification of the start of an element. |
open Unit |
unparsedEntityDecl(name: String!, publicId: String!, systemId: String!, notationName: String!) Receive notification of an unparsed entity declaration. |
open Unit |
warning(e: SAXParseException!) Receive notification of a parser warning. |
Public constructors
Public methods
characters
open funcharacters(
ch: CharArray!,
start: Int,
length: Int
): Unit
Deprecated: Deprecated in Java.
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).
Parameters | |
---|---|
ch |
CharArray!: The characters. |
start |
Int: The start position in the character array. |
length |
Int: The number of characters to use from the character array. |
Exceptions | |
---|---|
org.xml.sax.SAXException |
Any SAX exception, possibly wrapping another exception. |
endDocument
open funendDocument(): Unit
Deprecated: Deprecated in Java.
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).
Exceptions | |
---|---|
org.xml.sax.SAXException |
Any SAX exception, possibly wrapping another exception. |
endElement
open funendElement(name: String!): Unit
Deprecated: Deprecated in Java.
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).
Parameters | |
---|---|
name |
String!: the element name |
Exceptions | |
---|---|
org.xml.sax.SAXException |
Any SAX exception, possibly wrapping another exception. |
error
open funerror(e: SAXParseException!): Unit
Deprecated: Deprecated in Java.
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.
Parameters | |
---|---|
exception |
The error information encapsulated in a SAX parse exception. |
e |
SAXParseException!: The warning information encoded as an exception. |
Exceptions | |
---|---|
org.xml.sax.SAXException |
Any SAX exception, possibly wrapping another exception. |
fatalError
open funfatalError(e: SAXParseException!): Unit
Deprecated: Deprecated in Java.
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.
Parameters | |
---|---|
exception |
The error information encapsulated in a SAX parse exception. |
e |
SAXParseException!: The error information encoded as an exception. |
Exceptions | |
---|---|
org.xml.sax.SAXException |
Any SAX exception, possibly wrapping another exception. |
ignorableWhitespace
open funignorableWhitespace(
ch: CharArray!,
start: Int,
length: Int
): Unit
Deprecated: Deprecated in Java.
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).
Parameters | |
---|---|
ch |
CharArray!: The whitespace characters. |
start |
Int: The start position in the character array. |
length |
Int: The number of characters to use from the character array. |
Exceptions | |
---|---|
org.xml.sax.SAXException |
Any SAX exception, possibly wrapping another exception. |
notationDecl
open funnotationDecl(
name: String!,
publicId: String!,
systemId: String!
): Unit
Deprecated: Deprecated in Java.
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.
Parameters | |
---|---|
name |
String!: The notation name. |
publicId |
String!: The notation public identifier, or null if not available. |
systemId |
String!: The notation system identifier. |
See Also
processingInstruction
open funprocessingInstruction(
target: String!,
data: String!
): Unit
Deprecated: Deprecated in Java.
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.
Parameters | |
---|---|
target |
String!: The processing instruction target. |
data |
String!: The processing instruction data, or null if none is supplied. |
Exceptions | |
---|---|
org.xml.sax.SAXException |
Any SAX exception, possibly wrapping another exception. |
resolveEntity
open funresolveEntity(
publicId: String!,
systemId: String!
): InputSource!
Deprecated: Deprecated in Java.
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.
Parameters | |
---|---|
publicId |
String!: The public identifier, or null if none is available. |
systemId |
String!: The system identifier provided in the XML document. |
Return | |
---|---|
InputSource! |
The new input source, or null to require the default behaviour. |
Exceptions | |
---|---|
org.xml.sax.SAXException |
Any SAX exception, possibly wrapping another exception. |
setDocumentLocator
open funsetDocumentLocator(locator: Locator!): Unit
Deprecated: Deprecated in Java.
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.
Parameters | |
---|---|
locator |
Locator!: A locator for all SAX document events. |
startDocument
open funstartDocument(): Unit
Deprecated: Deprecated in Java.
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).
Exceptions | |
---|---|
org.xml.sax.SAXException |
Any SAX exception, possibly wrapping another exception. |
startElement
open funstartElement(
name: String!,
attributes: AttributeList!
): Unit
Deprecated: Deprecated in Java.
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).
Parameters | |
---|---|
name |
String!: The element type name. |
atts |
The attributes attached to the element, if any. |
attributes |
AttributeList!: The specified or defaulted attributes. |
Exceptions | |
---|---|
org.xml.sax.SAXException |
Any SAX exception, possibly wrapping another exception. |
unparsedEntityDecl
open fununparsedEntityDecl(
name: String!,
publicId: String!,
systemId: String!,
notationName: String!
): Unit
Deprecated: Deprecated in Java.
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.
Parameters | |
---|---|
name |
String!: The entity name. |
publicId |
String!: The entity public identifier, or null if not available. |
systemId |
String!: The entity system identifier. |
notationName |
String!: The name of the associated notation. |
warning
open funwarning(e: SAXParseException!): Unit
Deprecated: Deprecated in Java.
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.
Parameters | |
---|---|
exception |
The warning information encapsulated in a SAX parse exception. |
e |
SAXParseException!: The warning information encoded as an exception. |
Exceptions | |
---|---|
org.xml.sax.SAXException |
Any SAX exception, possibly wrapping another exception. |