程序包 ohos.org.xml.sax.helpers

类 DefaultHandler

java.lang.Object

ohos.org.xml.sax.helpers.DefaultHandler

所有已实现的接口:

ContentHandler, DTDHandler, EntityResolver, ErrorHandler

public class DefaultHandler
extends Object
implements EntityResolver, DTDHandler, ContentHandler, ErrorHandler

Default base class for SAX2 event 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 is available as a convenience base class for SAX2 applications: it provides default implementations for all of the callbacks in the four core SAX2 handler classes:

• EntityResolver
• DTDHandler
• ContentHandler
• ErrorHandler

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.

This class replaces the deprecated SAX1 HandlerBase class.

从以下版本开始:

SAX 2.0

另请参阅:

EntityResolver, DTDHandler, ContentHandler, ErrorHandler

构造器概要

构造器

构造器	说明
DefaultHandler()

方法概要

限定符和类型	方法	说明
void	characters(char[] ch, int start, int length)	Receive notification of character data inside an element.
void	endDocument()	Receive notification of the end of the document.
void	endElement(String uri, String localName, String qName)	Receive notification of the end of an element.
void	endPrefixMapping(String prefix)	Receive notification of the end of a Namespace mapping.
void	error(SAXParseException e)	Receive notification of a recoverable parser error.
void	fatalError(SAXParseException e)	Report a fatal XML parsing error.
void	ignorableWhitespace(char[] ch, int start, int length)	Receive notification of ignorable whitespace in element content.
void	notationDecl(String name, String publicId, String systemId)	Receive notification of a notation declaration.
void	processingInstruction(String target, String data)	Receive notification of a processing instruction.
InputSource	resolveEntity(String publicId, String systemId)	Resolve an external entity.
void	setDocumentLocator(Locator locator)	Receive a Locator object for document events.
void	skippedEntity(String name)	Receive notification of a skipped entity.
void	startDocument()	Receive notification of the beginning of the document.
void	startElement(String uri, String localName, String qName, Attributes attributes)	Receive notification of the start of an element.
void	startPrefixMapping(String prefix, String uri)	Receive notification of the start of a Namespace mapping.
void	unparsedEntityDecl(String name, String publicId, String systemId, String notationName)	Receive notification of an unparsed entity declaration.
void	warning(SAXParseException e)	Receive notification of a parser warning.

从类继承的方法 java.lang.Object

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

构造器详细资料

DefaultHandler

public DefaultHandler()

方法详细资料

resolveEntity

public InputSource resolveEntity(String publicId,
                                 String systemId)
                          throws IOException,
                                 SAXException

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.

指定者:

resolveEntity 在接口中 EntityResolver

参数:

publicId - The public identifier, or null if none is available.

systemId - The system identifier provided in the XML document.

返回:

The new input source, or null to require the default behaviour.

抛出:

IOException - If there is an error setting up the new input source.

SAXException - Any SAX exception, possibly wrapping another exception.

另请参阅:

EntityResolver.resolveEntity(java.lang.String, java.lang.String)

notationDecl

public void notationDecl(String name,
                         String publicId,
                         String systemId)
                  throws SAXException

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.

指定者:

notationDecl 在接口中 DTDHandler

参数:

name - The notation name.

publicId - The notation public identifier, or null if not available.

systemId - The notation system identifier.

抛出:

SAXException - Any SAX exception, possibly wrapping another exception.

另请参阅:

DTDHandler.notationDecl(java.lang.String, java.lang.String, java.lang.String)

unparsedEntityDecl

public void unparsedEntityDecl(String name,
                               String publicId,
                               String systemId,
                               String notationName)
                        throws SAXException

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.

指定者:

unparsedEntityDecl 在接口中 DTDHandler

参数:

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.

抛出:

SAXException - Any SAX exception, possibly wrapping another exception.

另请参阅:

DTDHandler.unparsedEntityDecl(java.lang.String, java.lang.String, java.lang.String, java.lang.String)

setDocumentLocator

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.

指定者:

setDocumentLocator 在接口中 ContentHandler

参数:

locator - A locator for all SAX document events.

另请参阅:

ContentHandler.setDocumentLocator(ohos.org.xml.sax.Locator), Locator

startDocument

public void startDocument()
                   throws SAXException

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

指定者:

startDocument 在接口中 ContentHandler

抛出:

SAXException - Any SAX exception, possibly wrapping another exception.

另请参阅:

ContentHandler.startDocument()

endDocument

public void endDocument()
                 throws SAXException

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

指定者:

endDocument 在接口中 ContentHandler

抛出:

SAXException - Any SAX exception, possibly wrapping another exception.

另请参阅:

ContentHandler.endDocument()

startPrefixMapping

public void startPrefixMapping(String prefix,
                               String uri)
                        throws SAXException

Receive notification of the start of a Namespace mapping.

By default, do nothing. Application writers may override this method in a subclass to take specific actions at the start of each Namespace prefix scope (such as storing the prefix mapping).

指定者:

startPrefixMapping 在接口中 ContentHandler

参数:

prefix - The Namespace prefix being declared.

uri - The Namespace URI mapped to the prefix.

抛出:

SAXException - Any SAX exception, possibly wrapping another exception.

另请参阅:

ContentHandler.startPrefixMapping(java.lang.String, java.lang.String)

endPrefixMapping

public void endPrefixMapping(String prefix)
                      throws SAXException

Receive notification of the end of a Namespace mapping.

By default, do nothing. Application writers may override this method in a subclass to take specific actions at the end of each prefix mapping.

指定者:

endPrefixMapping 在接口中 ContentHandler

参数:

prefix - The Namespace prefix being declared.

抛出:

SAXException - Any SAX exception, possibly wrapping another exception.

另请参阅:

ContentHandler.endPrefixMapping(java.lang.String)

startElement

public void startElement(String uri,
                         String localName,
                         String qName,
                         Attributes attributes)
                  throws SAXException

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

指定者:

startElement 在接口中 ContentHandler

参数:

uri - The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed.

localName - The local name (without prefix), or the empty string if Namespace processing is not being performed.

qName - The qualified name (with prefix), or the empty string if qualified names are not available.

attributes - The attributes attached to the element. If there are no attributes, it shall be an empty Attributes object.

抛出:

SAXException - Any SAX exception, possibly wrapping another exception.

另请参阅:

ContentHandler.startElement(java.lang.String, java.lang.String, java.lang.String, ohos.org.xml.sax.Attributes)

endElement

public void endElement(String uri,
                       String localName,
                       String qName)
                throws SAXException

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

指定者:

endElement 在接口中 ContentHandler

参数:

uri - The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed.

localName - The local name (without prefix), or the empty string if Namespace processing is not being performed.

qName - The qualified name (with prefix), or the empty string if qualified names are not available.

抛出:

SAXException - Any SAX exception, possibly wrapping another exception.

另请参阅:

ContentHandler.endElement(java.lang.String, java.lang.String, java.lang.String)

characters

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

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

指定者:

characters 在接口中 ContentHandler

参数:

ch - The characters.

start - The start position in the character array.

length - The number of characters to use from the character array.

抛出:

SAXException - Any SAX exception, possibly wrapping another exception.

另请参阅:

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

ignorableWhitespace

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

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

指定者:

ignorableWhitespace 在接口中 ContentHandler

参数:

ch - The whitespace characters.

start - The start position in the character array.

length - The number of characters to use from the character array.

抛出:

SAXException - Any SAX exception, possibly wrapping another exception.

另请参阅:

ContentHandler.ignorableWhitespace(char[], int, int)

processingInstruction

public void processingInstruction(String target,
                                  String data)
                           throws SAXException

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.

指定者:

processingInstruction 在接口中 ContentHandler

参数:

target - The processing instruction target.

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

抛出:

SAXException - Any SAX exception, possibly wrapping another exception.

另请参阅:

ContentHandler.processingInstruction(java.lang.String, java.lang.String)

skippedEntity

public void skippedEntity(String name)
                   throws SAXException

Receive notification of a skipped entity.

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.

指定者:

skippedEntity 在接口中 ContentHandler

参数:

name - The name of the skipped entity.

抛出:

SAXException - Any SAX exception, possibly wrapping another exception.

另请参阅:

ContentHandler.processingInstruction(java.lang.String, java.lang.String)

warning

public void warning(SAXParseException e)
             throws SAXException

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.

指定者:

warning 在接口中 ErrorHandler

参数:

e - The warning information encoded as an exception.

抛出:

SAXException - Any SAX exception, possibly wrapping another exception.

另请参阅:

ErrorHandler.warning(ohos.org.xml.sax.SAXParseException), SAXParseException

error

public void error(SAXParseException e)
           throws SAXException

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.

指定者:

error 在接口中 ErrorHandler

参数:

e - The error information encoded as an exception.

抛出:

SAXException - Any SAX exception, possibly wrapping another exception.

另请参阅:

ErrorHandler.warning(ohos.org.xml.sax.SAXParseException), SAXParseException

fatalError

public void fatalError(SAXParseException e)
                throws SAXException

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.

指定者:

fatalError 在接口中 ErrorHandler

参数:

e - The error information encoded as an exception.

抛出:

SAXException - Any SAX exception, possibly wrapping another exception.

另请参阅:

ErrorHandler.fatalError(ohos.org.xml.sax.SAXParseException), SAXParseException