| com.sun.xml.stream.xerces.xni.XMLDocumentHandler
| XMLDocumentHandler | | public interface XMLDocumentHandler (Code) | | The document handler interface defines callback methods to report
information items in XML documents. Parser components interested in
document information implement this interface and are registered
as the document handler on the document source.
author:
Andy Clark, IBM
version:
$Id: XMLDocumentHandler.java,v 1.2 2006/04/01 06:01:45 jeffsuttor Exp $ |
| Method Summary | |
| public void | characters(XMLString text, Augmentations augs)
Character content. | | public void | comment(XMLString text, Augmentations augs)
A comment. | | public void | doctypeDecl(String rootElement, String publicId, String systemId, Augmentations augs)
Notifies of the presence of the DOCTYPE line in the document. | | public void | emptyElement(QName element, XMLAttributes attributes, Augmentations augs)
An empty element. | | public void | endCDATA(Augmentations augs)
The end of a CDATA section. | | public void | endDocument(Augmentations augs)
The end of the document. | | public void | endElement(QName element, Augmentations augs)
The end of an element. | | public void | endGeneralEntity(String name, Augmentations augs)
This method notifies the end of a general entity. | | public void | endPrefixMapping(String prefix, Augmentations augs)
The end of a namespace prefix mapping. | | public XMLDocumentSource | getDocumentSource()
Returns the document source. | | public void | ignorableWhitespace(XMLString text, Augmentations augs)
Ignorable whitespace. | | public void | processingInstruction(String target, XMLString data, Augmentations augs)
A processing instruction. | | public void | setDocumentSource(XMLDocumentSource source)
Sets the document source. | | public void | startCDATA(Augmentations augs)
The start of a CDATA section. | | public void | startDocument(XMLLocator locator, String encoding, NamespaceContext namespaceContext, Augmentations augs)
The start of the document.
Parameters:
locator - The document locator, or null if the documentlocation cannot be reported during the parsingof this document. | | public void | startElement(QName element, XMLAttributes attributes, Augmentations augs)
The start of an element. | | public void | startGeneralEntity(String name, XMLResourceIdentifier identifier, String encoding, Augmentations augs)
This method notifies the start of a general entity.
Note: This method is not called for entity references
appearing as part of attribute values.
Parameters:
name - The name of the general entity.
Parameters:
identifier - The resource identifier.
Parameters:
encoding - The auto-detected IANA encoding name of the entitystream. | | public void | startPrefixMapping(String prefix, String uri, Augmentations augs)
The start of a namespace prefix mapping. | | public void | textDecl(String version, String encoding, Augmentations augs)
Notifies of the presence of a TextDecl line in an entity. | | public void | xmlDecl(String version, String encoding, String standalone, Augmentations augs)
Notifies of the presence of an XMLDecl line in the document. |
| characters | | public void characters(XMLString text, Augmentations augs) throws XNIException(Code) | | Character content.
Parameters:
text - The content.
Parameters:
augs - Additional information that may include infoset augmentations
exception:
XNIException - Thrown by handler to signal an error. |
| comment | | public void comment(XMLString text, Augmentations augs) throws XNIException(Code) | | A comment.
Parameters:
text - The text in the comment.
Parameters:
augs - Additional information that may include infoset augmentations
exception:
XNIException - Thrown by application to signal an error. |
| doctypeDecl | | public void doctypeDecl(String rootElement, String publicId, String systemId, Augmentations augs) throws XNIException(Code) | | Notifies of the presence of the DOCTYPE line in the document.
Parameters:
rootElement - The name of the root element.
Parameters:
publicId - The public identifier if an external DTD or nullif the external DTD is specified using SYSTEM.
Parameters:
systemId - The system identifier if an external DTD, nullotherwise.
Parameters:
augs - Additional information that may include infoset augmentations
exception:
XNIException - Thrown by handler to signal an error. |
| emptyElement | | public void emptyElement(QName element, XMLAttributes attributes, Augmentations augs) throws XNIException(Code) | | An empty element.
Parameters:
element - The name of the element.
Parameters:
attributes - The element attributes.
Parameters:
augs - Additional information that may include infoset augmentations
exception:
XNIException - Thrown by handler to signal an error. |
| endCDATA | | public void endCDATA(Augmentations augs) throws XNIException(Code) | | The end of a CDATA section.
Parameters:
augs - Additional information that may include infoset augmentations
exception:
XNIException - Thrown by handler to signal an error. |
| endDocument | | public void endDocument(Augmentations augs) throws XNIException(Code) | | The end of the document.
Parameters:
augs - Additional information that may include infoset augmentations
exception:
XNIException - Thrown by handler to signal an error. |
| endElement | | public void endElement(QName element, Augmentations augs) throws XNIException(Code) | | The end of an element.
Parameters:
element - The name of the element.
Parameters:
augs - Additional information that may include infoset augmentations
exception:
XNIException - Thrown by handler to signal an error. |
| endGeneralEntity | | public void endGeneralEntity(String name, Augmentations augs) throws XNIException(Code) | | This method notifies the end of a general entity.
Note: This method is not called for entity references
appearing as part of attribute values.
Parameters:
name - The name of the entity.
Parameters:
augs - Additional information that may include infoset augmentations
exception:
XNIException - Thrown by handler to signal an error. |
| endPrefixMapping | | public void endPrefixMapping(String prefix, Augmentations augs) throws XNIException(Code) | | The end of a namespace prefix mapping. This method will only be
called when namespace processing is enabled.
Parameters:
prefix - The namespace prefix.
Parameters:
augs - Additional information that may include infoset augmentations
exception:
XNIException - Thrown by handler to signal an error. |
| ignorableWhitespace | | public void ignorableWhitespace(XMLString text, Augmentations augs) throws XNIException(Code) | | Ignorable whitespace. For this method to be called, the document
source must have some way of determining that the text containing
only whitespace characters should be considered ignorable. For
example, the validator can determine if a length of whitespace
characters in the document are ignorable based on the element
content model.
Parameters:
text - The ignorable whitespace.
Parameters:
augs - Additional information that may include infoset augmentations
exception:
XNIException - Thrown by handler to signal an error. |
| processingInstruction | | public void processingInstruction(String target, XMLString data, Augmentations augs) throws XNIException(Code) | | A processing instruction. Processing instructions consist of a
target name and, optionally, text data. The data is only meaningful
to the application.
Typically, a processing instruction's data will contain a series
of pseudo-attributes. These pseudo-attributes follow the form of
element attributes but are not parsed or presented
to the application as anything other than text. The application is
responsible for parsing the data.
Parameters:
target - The target.
Parameters:
data - The data or null if none specified.
Parameters:
augs - Additional information that may include infoset augmentations
exception:
XNIException - Thrown by handler to signal an error. |
| startCDATA | | public void startCDATA(Augmentations augs) throws XNIException(Code) | | The start of a CDATA section.
Parameters:
augs - Additional information that may include infoset augmentations
exception:
XNIException - Thrown by handler to signal an error. |
| startDocument | | public void startDocument(XMLLocator locator, String encoding, NamespaceContext namespaceContext, Augmentations augs) throws XNIException(Code) | | The start of the document.
Parameters:
locator - The document locator, or null if the documentlocation cannot be reported during the parsingof this document. However, it is stronglyrecommended that a locator be supplied that canat least report the system identifier of thedocument.
Parameters:
encoding - The auto-detected IANA encoding name of the entitystream. This value will be null in those situationswhere the entity encoding is not auto-detected (e.g.internal entities or a document entity that isparsed from a java.io.Reader).
Parameters:
namespaceContext - The namespace context in effect at thestart of this document.This object represents the current context.Implementors of this class are responsiblefor copying the namespace bindings from thethe current context (and its parent contexts)if that information is important.
Parameters:
augs - Additional information that may include infoset augmentations
exception:
XNIException - Thrown by handler to signal an error. |
| startElement | | public void startElement(QName element, XMLAttributes attributes, Augmentations augs) throws XNIException(Code) | | The start of an element.
Parameters:
element - The name of the element.
Parameters:
attributes - The element attributes.
Parameters:
augs - Additional information that may include infoset augmentations
exception:
XNIException - Thrown by handler to signal an error. |
| startGeneralEntity | | public void startGeneralEntity(String name, XMLResourceIdentifier identifier, String encoding, Augmentations augs) throws XNIException(Code) | | This method notifies the start of a general entity.
Note: This method is not called for entity references
appearing as part of attribute values.
Parameters:
name - The name of the general entity.
Parameters:
identifier - The resource identifier.
Parameters:
encoding - The auto-detected IANA encoding name of the entitystream. This value will be null in those situationswhere the entity encoding is not auto-detected (e.g.internal entities or a document entity that isparsed from a java.io.Reader).
Parameters:
augs - Additional information that may include infoset augmentations
exception:
XNIException - Thrown by handler to signal an error. |
| startPrefixMapping | | public void startPrefixMapping(String prefix, String uri, Augmentations augs) throws XNIException(Code) | | The start of a namespace prefix mapping. This method will only be
called when namespace processing is enabled.
Parameters:
prefix - The namespace prefix.
Parameters:
uri - The URI bound to the prefix.
Parameters:
augs - Additional information that may include infoset augmentations
exception:
XNIException - Thrown by handler to signal an error. |
| textDecl | | public void textDecl(String version, String encoding, Augmentations augs) throws XNIException(Code) | | Notifies of the presence of a TextDecl line in an entity. If present,
this method will be called immediately following the startEntity call.
Note: This method will never be called for the
document entity; it is only called for external general entities
referenced in document content.
Note: This method is not called for entity references
appearing as part of attribute values.
Parameters:
version - The XML version, or null if not specified.
Parameters:
encoding - The IANA encoding name of the entity.
Parameters:
augs - Additional information that may include infoset augmentations
exception:
XNIException - Thrown by handler to signal an error. |
| xmlDecl | | public void xmlDecl(String version, String encoding, String standalone, Augmentations augs) throws XNIException(Code) | | Notifies of the presence of an XMLDecl line in the document. If
present, this method will be called immediately following the
startDocument call.
Parameters:
version - The XML version.
Parameters:
encoding - The IANA encoding name of the document, or null ifnot specified.
Parameters:
standalone - The standalone value, or null if not specified.
Parameters:
augs - Additional information that may include infoset augmentations
exception:
XNIException - Thrown by handler to signal an error. |
|
|