|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.
Method Summary | |
void |
characters(XMLString text)
Character content. |
void |
comment(XMLString text)
A comment. |
void |
doctypeDecl(java.lang.String rootElement,
java.lang.String publicId,
java.lang.String systemId)
Notifies of the presence of the DOCTYPE line in the document. |
void |
emptyElement(QName element,
XMLAttributes attributes)
An empty element. |
void |
endCDATA()
The end of a CDATA section. |
void |
endDocument()
The end of the document. |
void |
endElement(QName element)
The end of an element. |
void |
endEntity(java.lang.String name)
This method notifies the end of an entity. |
void |
endPrefixMapping(java.lang.String prefix)
The end of a namespace prefix mapping. |
void |
ignorableWhitespace(XMLString text)
Ignorable whitespace. |
void |
processingInstruction(java.lang.String target,
XMLString data)
A processing instruction. |
void |
startCDATA()
The start of a CDATA section. |
void |
startDocument(XMLLocator locator,
java.lang.String encoding)
The start of the document. |
void |
startElement(QName element,
XMLAttributes attributes)
The start of an element. |
void |
startEntity(java.lang.String name,
java.lang.String publicId,
java.lang.String systemId,
java.lang.String baseSystemId,
java.lang.String encoding)
This method notifies the start of an entity. |
void |
startPrefixMapping(java.lang.String prefix,
java.lang.String uri)
The start of a namespace prefix mapping. |
void |
textDecl(java.lang.String version,
java.lang.String encoding)
Notifies of the presence of a TextDecl line in an entity. |
void |
xmlDecl(java.lang.String version,
java.lang.String encoding,
java.lang.String standalone)
Notifies of the presence of an XMLDecl line in the document. |
Method Detail |
public void startDocument(XMLLocator locator, java.lang.String encoding) throws XNIException
locator
- The document locator, or null if the document
location cannot be reported during the parsing
of this document. However, it is strongly
recommended that a locator be supplied that can
at least report the system identifier of the
document.encoding
- The auto-detected IANA encoding name of the entity
stream. This value will be null in those situations
where the entity encoding is not auto-detected (e.g.
internal entities or a document entity that is
parsed from a java.io.Reader).public void xmlDecl(java.lang.String version, java.lang.String encoding, java.lang.String standalone) throws XNIException
version
- The XML version.encoding
- The IANA encoding name of the document, or null if
not specified.standalone
- The standalone value, or null if not specified.public void doctypeDecl(java.lang.String rootElement, java.lang.String publicId, java.lang.String systemId) throws XNIException
rootElement
- The name of the root element.publicId
- The public identifier if an external DTD or null
if the external DTD is specified using SYSTEM.systemId
- The system identifier if an external DTD, null
otherwise.public void comment(XMLString text) throws XNIException
text
- The text in the comment.public void processingInstruction(java.lang.String target, XMLString data) throws XNIException
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.
target
- The target.data
- The data or null if none specified.public void startPrefixMapping(java.lang.String prefix, java.lang.String uri) throws XNIException
prefix
- The namespace prefix.uri
- The URI bound to the prefix.public void startElement(QName element, XMLAttributes attributes) throws XNIException
element
- The name of the element.attributes
- The element attributes.public void emptyElement(QName element, XMLAttributes attributes) throws XNIException
element
- The name of the element.attributes
- The element attributes.public void startEntity(java.lang.String name, java.lang.String publicId, java.lang.String systemId, java.lang.String baseSystemId, java.lang.String encoding) throws XNIException
Note: This method is not called for entity references appearing as part of attribute values.
name
- The name of the entity.publicId
- The public identifier of the entity if the entity
is external, null otherwise.systemId
- The system identifier of the entity if the entity
is external, null otherwise.baseSystemId
- The base system identifier of the entity if
the entity is external, null otherwise.encoding
- The auto-detected IANA encoding name of the entity
stream. This value will be null in those situations
where the entity encoding is not auto-detected (e.g.
internal entities or a document entity that is
parsed from a java.io.Reader).public void textDecl(java.lang.String version, java.lang.String encoding) throws XNIException
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.
version
- The XML version, or null if not specified.encoding
- The IANA encoding name of the entity.public void endEntity(java.lang.String name) throws XNIException
Note: This method is not called for entity references appearing as part of attribute values.
name
- The name of the entity.public void characters(XMLString text) throws XNIException
text
- The content.public void ignorableWhitespace(XMLString text) throws XNIException
text
- The ignorable whitespace.public void endElement(QName element) throws XNIException
element
- The name of the element.public void endPrefixMapping(java.lang.String prefix) throws XNIException
prefix
- The namespace prefix.public void startCDATA() throws XNIException
public void endCDATA() throws XNIException
public void endDocument() throws XNIException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |