Class WellFormednessFilter

public WellFormednessFilter()

Swallows all events after performing well formedness checks.

public WellFormednessFilter(EventConsumer consumer)

Passes events through to the specified consumer, after first processing them.

public void characters(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).

Specified by:

characters in interface ContentHandler

Overrides:

characters in interface EventFilter

Parameters:

start - the start position in the array

length - the number of characters to read from the array

Throws:

SAXException - any SAX exception, possibly wrapping another exception

See Also:

ContentHandler.ignorableWhitespace(ch[],int,int), Locator

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

Report an XML comment anywhere in the document.

This callback will be used for comments inside or outside the document element, including comments in the external DTD subset (if read). Comments in the DTD must be properly nested inside start/endDTD and start/endEntity events (if used).

Specified by:

comment in interface LexicalHandler

Overrides:

comment in interface EventFilter

Parameters:

start - The starting position in the array.

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

Throws:

SAXException - The application may raise an exception.

public void endCDATA()
            throws SAXException

Report the end of a CDATA section.

Specified by:

endCDATA in interface LexicalHandler

Overrides:

endCDATA in interface EventFilter

Throws:

SAXException - The application may raise an exception.

See Also:

LexicalHandler.startCDATA()

public void endDTD()
            throws SAXException

Report the end of DTD declarations.

This method is intended to report the end of the DOCTYPE declaration; if the document has no DOCTYPE declaration, this method will not be invoked.

Specified by:

endDTD in interface LexicalHandler

Overrides:

endDTD in interface EventFilter

Throws:

SAXException - The application may raise an exception.

See Also:

LexicalHandler.startDTD(String,String,String)

public void endDocument()
            throws SAXException

Receive notification of the end of a document.

There is an apparent contradiction between the documentation for this method and the documentation for ErrorHandler.fatalError(SAXParseException). Until this ambiguity is resolved in a future major release, clients should make no assumptions about whether endDocument() will or will not be invoked when the parser has reported a fatalError() or thrown an exception.

The SAX parser will invoke this method only once, and it will be the last method invoked during the parse. The parser shall not invoke this method until it has either abandoned parsing (because of an unrecoverable error) or reached the end of input.

Specified by:

endDocument in interface ContentHandler

Overrides:

endDocument in interface EventFilter

Throws:

SAXException - any SAX exception, possibly wrapping another exception

See Also:

ContentHandler.startDocument()

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.

Specified by:

endElement in interface ContentHandler

Overrides:

endElement in interface EventFilter

Parameters:

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 XML name (with prefix), or the empty string if qualified names are not available

Throws:

SAXException - any SAX exception, possibly wrapping another exception

public void ignorableWhitespace(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.

Specified by:

ignorableWhitespace in interface ContentHandler

Overrides:

ignorableWhitespace in interface EventFilter

Parameters:

start - the start position in the array

length - the number of characters to read from the array

Throws:

SAXException - any SAX exception, possibly wrapping another exception

See Also:

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

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

Specified by:

notationDecl in interface DTDHandler

Overrides:

notationDecl in interface EventFilter

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.

Specified by:

processingInstruction in interface ContentHandler

Overrides:

processingInstruction in interface EventFilter

Parameters:

target - the processing instruction target

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

Throws:

SAXException - any SAX exception, possibly wrapping another exception

public void reset()

Resets state as if any preceding event stream was well formed. Particularly useful if it ended through some sort of error, and the endDocument call wasn't made.

public void setDocumentLocator(Locator locator)

Throws an exception when called after startDocument.

Specified by:

setDocumentLocator in interface ContentHandler

Overrides:

setDocumentLocator in interface EventFilter

Parameters:

locator - the locator, to be used in error reporting or relative URI resolution.

Throws:

IllegalStateException - when called after the document has already been started

public void startCDATA()
            throws SAXException

Report the start of a CDATA section.

The contents of the CDATA section will be reported through the regular characters event; this event is intended only to report the boundary.

Specified by:

startCDATA in interface LexicalHandler

Overrides:

startCDATA in interface EventFilter

Throws:

SAXException - The application may raise an exception.

See Also:

LexicalHandler.endCDATA()

public void startDTD(String root,
                     String publicId,
                     String systemId)
            throws SAXException

Report the start of DTD declarations, if any.

This method is intended to report the beginning of the DOCTYPE declaration; if the document has no DOCTYPE declaration, this method will not be invoked.

All declarations reported through DTDHandler or DeclHandler events must appear between the startDTD and endDTD events. Declarations are assumed to belong to the internal DTD subset unless they appear between startEntity and endEntity events. Comments and processing instructions from the DTD should also be reported between the startDTD and endDTD events, in their original order of (logical) occurrence; they are not required to appear in their correct locations relative to DTDHandler or DeclHandler events, however.

Note that the start/endDTD events will appear within the start/endDocument events from ContentHandler and before the first startElement event.

Specified by:

startDTD in interface LexicalHandler

Overrides:

startDTD in interface EventFilter

Parameters:

publicId - The declared public identifier for the external DTD subset, or null if none was declared.

systemId - The declared system identifier for the external DTD subset, or null if none was declared. (Note that this is not resolved against the document base URI.)

Throws:

SAXException - The application may raise an exception.

See Also:

LexicalHandler.endDTD(), LexicalHandler.startEntity(String)

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

Specified by:

startDocument in interface ContentHandler

Overrides:

startDocument in interface EventFilter

Throws:

SAXException - any SAX exception, possibly wrapping another exception

See Also:

ContentHandler.endDocument()

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:

1. the Namespace URI;
2. the local name; and
3. 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.

Specified by:

startElement in interface ContentHandler

Overrides:

startElement in interface EventFilter

Parameters:

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

atts - 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

Throws:

SAXException - any SAX exception, possibly wrapping another exception

See Also:

ContentHandler.endElement(String,String,String), Attributes, AttributesImpl

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

Specified by:

unparsedEntityDecl in interface DTDHandler

Overrides:

unparsedEntityDecl in interface EventFilter