OpenJDK 1.23 · org.xml.sax.ContentHandler · APIdia, the JavaDoc alternative

Modifier and Type	Method and Description
public void	characters(char[] the characters from the XML document ch, int the start position in the array start, int the number of characters to read from the array length) Receive notification of character data.
public default void	declaration(String the version string as in the input document, null if not specified version, String the encoding string as in the input document, null if not specified encoding, String the standalone string as in the input document, null if not specified standalone) Receives notification of the XML declaration.
public void	endDocument() Receive notification of the end of a document.
public void	endElement(String the Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed uri, String the local name (without prefix), or the empty string if Namespace processing is not being performed localName, String the qualified XML name (with prefix), or the empty string if qualified names are not available qName) Receive notification of the end of an element.
public void	endPrefixMapping(String the prefix that was being mapped. This is the empty string when a default mapping scope ends. prefix) End the scope of a prefix-URI mapping.
public void	ignorableWhitespace(char[] the characters from the XML document ch, int the start position in the array start, int the number of characters to read from the array length) Receive notification of ignorable whitespace in element content.
public void	processingInstruction(String the processing instruction target target, String the processing instruction data, or null if none was supplied. The data does not include any whitespace separating it from the target data) Receive notification of a processing instruction.
public void	setDocumentLocator(Locator an object that can return the location of any SAX document event locator) Receive an object for locating the origin of SAX document events.
public void	skippedEntity(String the name of the skipped entity. If it is a parameter entity, the name will begin with '%', and if it is the external DTD subset, it will be the string "[dtd]" name) Receive notification of a skipped entity.
public void	startDocument() Receive notification of the beginning of a document.
public void	startElement(String the Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed uri, String the local name (without prefix), or the empty string if Namespace processing is not being performed localName, String the qualified name (with prefix), or the empty string if qualified names are not available qName, Attributes the attributes attached to the element. If there are no attributes, it shall be an empty Attributes object. The value of this object after startElement returns is undefined atts) Receive notification of the beginning of an element.
public void	startPrefixMapping(String the Namespace prefix being declared. An empty string is used for the default element namespace, which has no prefix. prefix, String the Namespace URI the prefix is mapped to uri) Begin the scope of a prefix-URI Namespace mapping.

Method Detail

characters back to summary

characters	back to summary
public void characters(char[] ch, int start, int length) throws SAXException Receive notification of character data. The Parser will call this method to report each chunk of character data. SAX parsers may return all contiguous character data in a single chunk, or they may split it into several chunks; however, all of the characters in any single event must come from the same external entity so that the Locator provides useful information. The application must not attempt to read from the array outside of the specified range. Individual characters may consist of more than one Java `char` value. There are two important cases where this happens, because characters can't be represented in just sixteen bits. In one case, characters are represented in a Surrogate Pair, using two special Unicode values. Such characters are in the so-called "Astral Planes", with a code point above U+FFFF. A second case involves composite characters, such as a base character combining with one or more accent characters. Your code should not assume that algorithms using `char`-at-a-time idioms will be working in character units; in some cases they will split characters. This is relevant wherever XML permits arbitrary characters, such as attribute values, processing instruction data, and comments as well as in data reported from this method. It's also generally relevant whenever Java code manipulates internationalized text; the issue isn't unique to XML. Note that some parsers will report whitespace in element content using the `ignorableWhitespace` method rather than this one (validating parsers must do so). Parameters ch:char[] the characters from the XML document start:int the start position in the array length:int the number of characters to read from the array Exceptions SAXException: any SAX exception, possibly wrapping another exception See Also `ignorableWhitespace`, `org.xml.sax.Locator`

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

Receive notification of character data.

The Parser will call this method to report each chunk of character data. SAX parsers may return all contiguous character data in a single chunk, or they may split it into several chunks; however, all of the characters in any single event must come from the same external entity so that the Locator provides useful information.

The application must not attempt to read from the array outside of the specified range.

Individual characters may consist of more than one Java char value. There are two important cases where this happens, because characters can't be represented in just sixteen bits. In one case, characters are represented in a Surrogate Pair, using two special Unicode values. Such characters are in the so-called "Astral Planes", with a code point above U+FFFF. A second case involves composite characters, such as a base character combining with one or more accent characters.

Your code should not assume that algorithms using char-at-a-time idioms will be working in character units; in some cases they will split characters. This is relevant wherever XML permits arbitrary characters, such as attribute values, processing instruction data, and comments as well as in data reported from this method. It's also generally relevant whenever Java code manipulates internationalized text; the issue isn't unique to XML.

Note that some parsers will report whitespace in element content using the ignorableWhitespace method rather than this one (validating parsers must do so).

Parameters

ch:char[]: the characters from the XML document
start:int: the start position in the array
length:int: the number of characters to read from the array

Exceptions

SAXException:: any SAX exception, possibly wrapping another exception

declaration	back to summary
public default void declaration(String version, String encoding, String standalone) throws SAXException Receives notification of the XML declaration. Implementation Specification The default implementation in the SAX API is to do nothing. Parameters version:String the version string as in the input document, null if not specified encoding:String the encoding string as in the input document, null if not specified standalone:String the standalone string as in the input document, null if not specified Exceptions SAXException: if the application wants to report an error or interrupt the parsing process Since 14

declaration

back to summary

public default void declaration(String version, String encoding, String standalone) throws SAXException

Receives notification of the XML declaration.

Implementation Specification

The default implementation in the SAX API is to do nothing.

Parameters

version:String: the version string as in the input document, null if not specified
encoding:String: the encoding string as in the input document, null if not specified
standalone:String: the standalone string as in the input document, null if not specified

Exceptions

SAXException:: if the application wants to report an error or interrupt the parsing process

Since

endDocument back to summary

endDocument	back to summary
public void endDocument() throws SAXException Receive notification of the end of a document. This method is invoked by the parser to signal it has reached the end of the document after successfully completing the parsing process. After the event, the parser will return the control to the application. API Note In case of a fatal error, the parser may choose to stop the parsing process with a `SAXException`, in which case, this method will never be called. Refer to `ErrorHandler#fatalError(org.xml.sax.SAXParseException)`. Exceptions SAXException: any SAX exception, possibly wrapping another exception See Also `startDocument`

public void endDocument() throws SAXException

Receive notification of the end of a document.

This method is invoked by the parser to signal it has reached the end of the document after successfully completing the parsing process. After the event, the parser will return the control to the application.

API Note

In case of a fatal error, the parser may choose to stop the parsing process with a SAXException, in which case, this method will never be called. Refer to ErrorHandler#fatalError(org.xml.sax.SAXParseException).

Exceptions

SAXException:: any SAX exception, possibly wrapping another exception

See Also

startDocument

endElement back to summary

endElement	back to summary
public void endElement(String uri, String localName, String qName) throws SAXException Receive notification of the end of an element. The SAX parser will invoke this method at the end of every element in the XML document; there will be a corresponding `startElement` event for every endElement event (even when the element is empty). For information on the names, see startElement. Parameters uri:String the Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed localName:String the local name (without prefix), or the empty string if Namespace processing is not being performed qName:String the qualified XML name (with prefix), or the empty string if qualified names are not available Exceptions SAXException: any SAX exception, possibly wrapping another exception

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

Receive notification of the end of an element.

The SAX parser will invoke this method at the end of every element in the XML document; there will be a corresponding startElement event for every endElement event (even when the element is empty).

For information on the names, see startElement.

Parameters

uri:String: the Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed
localName:String: the local name (without prefix), or the empty string if Namespace processing is not being performed
qName:String: the qualified XML name (with prefix), or the empty string if qualified names are not available

Exceptions

SAXException:: any SAX exception, possibly wrapping another exception

endPrefixMapping back to summary

endPrefixMapping	back to summary
public void endPrefixMapping(String prefix) throws SAXException End the scope of a prefix-URI mapping. See `startPrefixMapping` for details. These events will always occur immediately after the corresponding `endElement` event, but the order of `endPrefixMapping` events is not otherwise guaranteed. Parameters prefix:String the prefix that was being mapped. This is the empty string when a default mapping scope ends. Exceptions SAXException: the client may throw an exception during processing See Also `startPrefixMapping`, `endElement`

public void endPrefixMapping(String prefix) throws SAXException

End the scope of a prefix-URI mapping.

See startPrefixMapping for details. These events will always occur immediately after the corresponding endElement event, but the order of endPrefixMapping events is not otherwise guaranteed.

Parameters

prefix:String: the prefix that was being mapped. This is the empty string when a default mapping scope ends.

Exceptions

SAXException:: the client may throw an exception during processing

See Also

startPrefixMapping, endElement

ignorableWhitespace back to summary

ignorableWhitespace	back to summary
public void ignorableWhitespace(char[] ch, int start, int length) throws SAXException Receive notification of ignorable whitespace in element content. Validating Parsers must use this method to report each chunk of whitespace in element content (see the W3C XML 1.0 recommendation, section 2.10): non-validating parsers may also use this method if they are capable of parsing and using content models. SAX parsers may return all contiguous whitespace in a single chunk, or they may split it into several chunks; however, all of the characters in any single event must come from the same external entity, so that the Locator provides useful information. The application must not attempt to read from the array outside of the specified range. Parameters ch:char[] the characters from the XML document start:int the start position in the array length:int the number of characters to read from the array Exceptions SAXException: any SAX exception, possibly wrapping another exception See Also `characters`

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

Receive notification of ignorable whitespace in element content.

Validating Parsers must use this method to report each chunk of whitespace in element content (see the W3C XML 1.0 recommendation, section 2.10): non-validating parsers may also use this method if they are capable of parsing and using content models.

SAX parsers may return all contiguous whitespace in a single chunk, or they may split it into several chunks; however, all of the characters in any single event must come from the same external entity, so that the Locator provides useful information.

The application must not attempt to read from the array outside of the specified range.

Parameters

ch:char[]: the characters from the XML document
start:int: the start position in the array
length:int: the number of characters to read from the array

Exceptions

SAXException:: any SAX exception, possibly wrapping another exception

See Also

characters

processingInstruction back to summary

processingInstruction	back to summary
public void processingInstruction(String target, String data) throws SAXException Receive notification of a processing instruction. The Parser will invoke this method once for each processing instruction found: note that processing instructions may occur before or after the main document element. A SAX parser must never report an XML declaration (XML 1.0, section 2.8) or a text declaration (XML 1.0, section 4.3.1) using this method. Like `characters()`, processing instruction data may have characters that need more than one `char` value. Parameters target:String the processing instruction target data:String the processing instruction data, or null if none was supplied. The data does not include any whitespace separating it from the target Exceptions SAXException: any SAX exception, possibly wrapping another exception

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

Receive notification of a processing instruction.

The Parser will invoke this method once for each processing instruction found: note that processing instructions may occur before or after the main document element.

A SAX parser must never report an XML declaration (XML 1.0, section 2.8) or a text declaration (XML 1.0, section 4.3.1) using this method.

Like characters(), processing instruction data may have characters that need more than one char value.

Parameters

target:String: the processing instruction target
data:String: the processing instruction data, or null if none was supplied. The data does not include any whitespace separating it from the target

Exceptions

SAXException:: any SAX exception, possibly wrapping another exception

setDocumentLocator back to summary

setDocumentLocator	back to summary
public void setDocumentLocator(Locator locator) Receive an object for locating the origin of SAX document events. SAX parsers are strongly encouraged (though not absolutely required) to supply a locator: if it does so, it must supply the locator to the application by invoking this method before invoking any of the other methods in the ContentHandler interface. The locator allows the application to determine the end position of any document-related event, even if the parser is not reporting an error. Typically, the application will use this information for reporting its own errors (such as character content that does not match an application's business rules). The information returned by the locator is probably not sufficient for use with a search engine. Note that the locator will return correct information only during the invocation SAX event callbacks after `startDocument` returns and before `endDocument` is called. The application should not attempt to use it at any other time. Parameters locator:Locator an object that can return the location of any SAX document event See Also `org.xml.sax.Locator`

public void setDocumentLocator(Locator locator)

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

SAX parsers are strongly encouraged (though not absolutely required) to supply a locator: if it does so, it must supply the locator to the application by invoking this method before invoking any of the other methods in the ContentHandler interface.

The locator allows the application to determine the end position of any document-related event, even if the parser is not reporting an error. Typically, the application will use this information for reporting its own errors (such as character content that does not match an application's business rules). The information returned by the locator is probably not sufficient for use with a search engine.

Note that the locator will return correct information only during the invocation SAX event callbacks after startDocument returns and before endDocument is called. The application should not attempt to use it at any other time.

Parameters

locator:Locator: an object that can return the location of any SAX document event

See Also

org.xml.sax.Locator

skippedEntity back to summary

skippedEntity	back to summary
public void skippedEntity(String name) throws SAXException Receive notification of a skipped entity. This is not called for entity references within markup constructs such as element start tags or markup declarations. (The XML recommendation requires reporting skipped external entities. SAX also reports internal entity expansion/non-expansion, except within markup constructs.) The Parser will invoke this method each time the entity is skipped. Non-validating processors may skip entities if they have not seen the declarations (because, for example, the entity was declared in an external DTD subset). All processors may skip external entities, depending on the values of the `http://xml.org/sax/features/external-general-entities` and the `http://xml.org/sax/features/external-parameter-entities` properties. Parameters name:String the name of the skipped entity. If it is a parameter entity, the name will begin with '%', and if it is the external DTD subset, it will be the string "[dtd]" Exceptions SAXException: any SAX exception, possibly wrapping another exception

public void skippedEntity(String name) throws SAXException

Receive notification of a skipped entity. This is not called for entity references within markup constructs such as element start tags or markup declarations. (The XML recommendation requires reporting skipped external entities. SAX also reports internal entity expansion/non-expansion, except within markup constructs.)

The Parser will invoke this method each time the entity is skipped. Non-validating processors may skip entities if they have not seen the declarations (because, for example, the entity was declared in an external DTD subset). All processors may skip external entities, depending on the values of the http://xml.org/sax/features/external-general-entities and the http://xml.org/sax/features/external-parameter-entities properties.

Parameters

name:String: the name of the skipped entity. If it is a parameter entity, the name will begin with '%', and if it is the external DTD subset, it will be the string "[dtd]"

Exceptions

SAXException:: any SAX exception, possibly wrapping another exception

startDocument back to summary

startDocument	back to summary
public void startDocument() throws SAXException Receive notification of the beginning of a document. The SAX parser will invoke this method only once, before any other event callbacks (except for `setDocumentLocator`). Exceptions SAXException: any SAX exception, possibly wrapping another exception See Also `endDocument`

public void startDocument() throws SAXException

Receive notification of the beginning of a document.

The SAX parser will invoke this method only once, before any other event callbacks (except for setDocumentLocator).

Exceptions

SAXException:: any SAX exception, possibly wrapping another exception

See Also

endDocument

startElement back to summary

startElement	back to summary
public void startElement(String uri, String localName, String qName, Attributes atts) throws SAXException Receive notification of the beginning of an element. The Parser will invoke this method at the beginning of every element in the XML document; there will be a corresponding `endElement` event for every startElement event (even when the element is empty). All of the element's content will be reported, in order, before the corresponding endElement event. This event allows up to three name components for each element: the Namespace URI; the local name; and the qualified (prefixed) name. Any or all of these may be provided, depending on the values of the `http://xml.org/sax/features/namespaces` and the `http://xml.org/sax/features/namespace-prefixes` properties: the Namespace URI and local name are required when the namespaces property is `true` (the default), and are optional when the namespaces property is `false` (if one is specified, both must be); the qualified name is required when the namespace-prefixes property is `true`, and is optional when the namespace-prefixes property is `false` (the default). Note that the attribute list provided will contain only attributes with explicit values (specified or defaulted): #IMPLIED attributes will be omitted. The attribute list will contain attributes used for Namespace declarations (xmlns* attributes) only if the `http://xml.org/sax/features/namespace-prefixes` property is true (it is false by default, and support for a true value is optional). Like `characters()`, attribute values may have characters that need more than one `char` value. Parameters uri:String the Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed localName:String the local name (without prefix), or the empty string if Namespace processing is not being performed qName:String the qualified name (with prefix), or the empty string if qualified names are not available atts:Attributes the attributes attached to the element. If there are no attributes, it shall be an empty Attributes object. The value of this object after startElement returns is undefined Exceptions SAXException: any SAX exception, possibly wrapping another exception See Also `endElement`, `org.xml.sax.Attributes`, `org.xml.sax.helpers.AttributesImpl`

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

Receive notification of the beginning of an element.

The Parser will invoke this method at the beginning of every element in the XML document; there will be a corresponding endElement event for every startElement event (even when the element is empty). All of the element's content will be reported, in order, before the corresponding endElement event.

This event allows up to three name components for each element:

the Namespace URI;
the local name; and
the qualified (prefixed) name.

Any or all of these may be provided, depending on the values of the http://xml.org/sax/features/namespaces and the http://xml.org/sax/features/namespace-prefixes properties:

the Namespace URI and local name are required when the namespaces property is true (the default), and are optional when the namespaces property is false (if one is specified, both must be);
the qualified name is required when the namespace-prefixes property is true, and is optional when the namespace-prefixes property is false (the default).

Note that the attribute list provided will contain only attributes with explicit values (specified or defaulted): #IMPLIED attributes will be omitted. The attribute list will contain attributes used for Namespace declarations (xmlns* attributes) only if the http://xml.org/sax/features/namespace-prefixes property is true (it is false by default, and support for a true value is optional).

Like characters(), attribute values may have characters that need more than one char value.

Parameters

uri:String: the Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed
localName:String: the local name (without prefix), or the empty string if Namespace processing is not being performed
qName:String: the qualified name (with prefix), or the empty string if qualified names are not available
atts:Attributes: the attributes attached to the element. If there are no attributes, it shall be an empty Attributes object. The value of this object after startElement returns is undefined

Exceptions

SAXException:: any SAX exception, possibly wrapping another exception

startPrefixMapping back to summary

startPrefixMapping	back to summary
public void startPrefixMapping(String prefix, String uri) throws SAXException Begin the scope of a prefix-URI Namespace mapping. The information from this event is not necessary for normal Namespace processing: the SAX XML reader will automatically replace prefixes for element and attribute names when the `http://xml.org/sax/features/namespaces` feature is `true` (the default). There are cases, however, when applications need to use prefixes in character data or in attribute values, where they cannot safely be expanded automatically; the start/endPrefixMapping event supplies the information to the application to expand prefixes in those contexts itself, if necessary. Note that start/endPrefixMapping events are not guaranteed to be properly nested relative to each other: all startPrefixMapping events will occur immediately before the corresponding `startElement` event, and all `endPrefixMapping` events will occur immediately after the corresponding `endElement` event, but their order is not otherwise guaranteed. There should never be start/endPrefixMapping events for the "xml" prefix, since it is predeclared and immutable. Parameters prefix:String the Namespace prefix being declared. An empty string is used for the default element namespace, which has no prefix. uri:String the Namespace URI the prefix is mapped to Exceptions SAXException: the client may throw an exception during processing See Also `endPrefixMapping`, `startElement`

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

Begin the scope of a prefix-URI Namespace mapping.

The information from this event is not necessary for normal Namespace processing: the SAX XML reader will automatically replace prefixes for element and attribute names when the http://xml.org/sax/features/namespaces feature is true (the default).

There are cases, however, when applications need to use prefixes in character data or in attribute values, where they cannot safely be expanded automatically; the start/endPrefixMapping event supplies the information to the application to expand prefixes in those contexts itself, if necessary.

Note that start/endPrefixMapping events are not guaranteed to be properly nested relative to each other: all startPrefixMapping events will occur immediately before the corresponding startElement event, and all endPrefixMapping events will occur immediately after the corresponding endElement event, but their order is not otherwise guaranteed.

There should never be start/endPrefixMapping events for the "xml" prefix, since it is predeclared and immutable.

Parameters

prefix:String: the Namespace prefix being declared. An empty string is used for the default element namespace, which has no prefix.
uri:String: the Namespace URI the prefix is mapped to

Exceptions

SAXException:: the client may throw an exception during processing

See Also

endPrefixMapping, startElement

public Interface ContentHandler

Method Summary

Method Detail