nu.validator.checker

Class NormalizationChecker

java.lang.Object

nu.validator.checker.Checker

nu.validator.checker.NormalizationChecker

All Implemented Interfaces:

org.xml.sax.ContentHandler

public final class NormalizationChecker
extends Checker

Checks that the following constructs do not start with a composing character:

• Local names of elements
• Local names of attributes
• Attribute values
• Declared namespace prefixes
• Declared namespace URIs
• PI targets
• PI data
• Concatenations of consecutive character data between element boundaries and PIs ignoring comments and CDATA section boundaries.

Checks that the following constructs are in the Unicode Normalization Form C. (It is assumed the normalization of the rest of the constructs is enforced by other means, such as checking the document source for normalization.)

• Attribute values
• PI data
• Concatenations of consecutive character data between element boundaries and PIs ignoring comments and CDATA section boundaries.

All Strings must be valid UTF-16!

This class can also be used as a source code mode where the source code of the document is fed to characters(). The mode modifies the error messages appropriately.

Version:

$Id$

Author:

hsivonen

Constructor Summary

Constructors

Constructor and Description
NormalizationChecker() Constructor for non-source mode.
NormalizationChecker(boolean sourceTextMode) Constructor with mode selection.

Method Summary

Modifier and Type	Method and Description
void	characters(char[] ch, int start, int length) In the normal mode, this method has the usual SAX semantics.
void	endElement(java.lang.String uri, java.lang.String localName, java.lang.String qName)
void	flush() Called to indicate the end of a run of characters.
void	processingInstruction(java.lang.String target, java.lang.String data)
void	reset() Does nothing.
void	startElement(java.lang.String uri, java.lang.String localName, java.lang.String qName, org.xml.sax.Attributes atts)
void	startPrefixMapping(java.lang.String prefix, java.lang.String uri)
static boolean	startsWithComposingChar(java.lang.String str) Returns true if the argument starts with a composing character and false otherwise.

Methods inherited from class nu.validator.checker.Checker

endDocument, endPrefixMapping, err, err, getDocumentLocator, getErrorHandler, ignorableWhitespace, setDocumentLocator, setErrorHandler, skippedEntity, startDocument, warn, warn

Methods inherited from class java.lang.Object

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

Constructor Detail

NormalizationChecker

public NormalizationChecker()

Constructor for non-source mode.

NormalizationChecker

public NormalizationChecker(boolean sourceTextMode)

Constructor with mode selection.

Parameters:

sourceTextMode - whether the source text-related messages should be enabled.

Method Detail

startsWithComposingChar

public static boolean startsWithComposingChar(java.lang.String str)
                                       throws org.xml.sax.SAXException

Returns true if the argument starts with a composing character and false otherwise.

Parameters:

str - a string

Returns:

true if the argument starts with a composing character and false otherwise.

Throws:

org.xml.sax.SAXException - on malformed UTF-16

reset

public void reset()

Description copied from class: Checker

Does nothing. Subclasses are expected to override this method with an implementation that clears the state of the checker and releases objects the checker might hold references to.

Overrides:

reset in class Checker

See Also:

Checker.reset()

characters

public void characters(char[] ch,
                       int start,
                       int length)
                throws org.xml.sax.SAXException

In the normal mode, this method has the usual SAX semantics. In the source text mode, this method is used for reporting the source text.

Specified by:

characters in interface org.xml.sax.ContentHandler

Overrides:

characters in class Checker

Throws:

org.xml.sax.SAXException

See Also:

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

endElement

public void endElement(java.lang.String uri,
                       java.lang.String localName,
                       java.lang.String qName)
                throws org.xml.sax.SAXException

Specified by:

endElement in interface org.xml.sax.ContentHandler

Overrides:

endElement in class Checker

Throws:

org.xml.sax.SAXException

See Also:

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

processingInstruction

public void processingInstruction(java.lang.String target,
                                  java.lang.String data)
                           throws org.xml.sax.SAXException

Specified by:

processingInstruction in interface org.xml.sax.ContentHandler

Overrides:

processingInstruction in class Checker

Throws:

org.xml.sax.SAXException

See Also:

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

startElement

public void startElement(java.lang.String uri,
                         java.lang.String localName,
                         java.lang.String qName,
                         org.xml.sax.Attributes atts)
                  throws org.xml.sax.SAXException

Specified by:

startElement in interface org.xml.sax.ContentHandler

Overrides:

startElement in class Checker

Throws:

org.xml.sax.SAXException

See Also:

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

startPrefixMapping

public void startPrefixMapping(java.lang.String prefix,
                               java.lang.String uri)
                        throws org.xml.sax.SAXException

Specified by:

startPrefixMapping in interface org.xml.sax.ContentHandler

Overrides:

startPrefixMapping in class Checker

Throws:

org.xml.sax.SAXException

See Also:

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

flush

public void flush()
           throws org.xml.sax.SAXException

Called to indicate the end of a run of characters. When this class is used for checking source text, this method should be called after all the calls to characters().

Throws:

org.xml.sax.SAXException - if the ErrorHandler throws.