Package nu.validator.checker

Class Checker

java.lang.Object
nu.validator.checker.Checker
All Implemented Interfaces:
org.xml.sax.ContentHandler
Direct Known Subclasses:
Assertions, ConformingButObsoleteWarner, DebugChecker, LanguageDetectingChecker, MicrodataChecker, NormalizationChecker, RdfaLiteChecker, TableChecker, TextContentChecker, UncheckedSubtreeWarner, UnsupportedFeatureChecker, UsemapChecker, XmlPiChecker
public abstract class Checker
extends java.lang.Object
implements org.xml.sax.ContentHandler
The abstract base class for SAX-based content checkers that listen to the ContentHandler events and emit errors and warnings to an ErrorHandler.

Always delegates ignorableWhitespace() to characters(). The other ContentHandler methods here are stubs that do nothing. Subclasses, therefore, never need to call the superclass methods.

Version:
$Id$
Author:
hsivonen

  • Constructor Summary

    Constructors 
    Constructor Description
    Checker()
    Constructor.

  • Method Summary

    Modifier and Type Method Description
    void characters​(char[] ch, int start, int length)  
    void endDocument()
    Calls reset().
    void endElement​(java.lang.String uri, java.lang.String localName, java.lang.String qName)  
    void endPrefixMapping​(java.lang.String prefix)  
    void err​(java.lang.String message)
    Emit an error.
    void err​(java.lang.String message, org.xml.sax.Locator overrideLocator)
    Emit an error with specified locator.
    org.xml.sax.Locator getDocumentLocator()
    Returns the locator.
    org.xml.sax.ErrorHandler getErrorHandler()
    Returns the errorHandler.
    javax.servlet.http.HttpServletRequest getRequest()  
    void ignorableWhitespace​(char[] ch, int start, int length)
    Calls characters().
    void processingInstruction​(java.lang.String target, java.lang.String data)  
    void reset()
    Does nothing.
    void setDocumentLocator​(org.xml.sax.Locator locator)  
    void setErrorHandler​(org.xml.sax.ErrorHandler errorHandler)
    Sets the errorHandler.
    void setRequest​(javax.servlet.http.HttpServletRequest request)  
    void skippedEntity​(java.lang.String name)  
    void startDocument()
    Calls reset().
    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)  
    void warn​(java.lang.String message)
    Emit a warning.
    void warn​(java.lang.String message, org.xml.sax.Locator overrideLocator)
    Emit a warning with specified locator.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • Checker

      public Checker()
      Constructor.

  • Method Details

    • warn

      public void warn​(java.lang.String message) throws org.xml.sax.SAXException
      Emit a warning. The locator is used.
      Parameters:
      message - the warning message
      Throws:
      org.xml.sax.SAXException - if something goes wrong

    • warn

      public void warn​(java.lang.String message, org.xml.sax.Locator overrideLocator) throws org.xml.sax.SAXException
      Emit a warning with specified locator.
      Parameters:
      message - the warning message
      Throws:
      org.xml.sax.SAXException - if something goes wrong

    • err

      public void err​(java.lang.String message, org.xml.sax.Locator overrideLocator) throws org.xml.sax.SAXException
      Emit an error with specified locator.
      Parameters:
      message - the error message
      Throws:
      org.xml.sax.SAXException - if something goes wrong

    • err

      public void err​(java.lang.String message) throws org.xml.sax.SAXException
      Emit an error. The locator is used.
      Parameters:
      message - the error message
      Throws:
      org.xml.sax.SAXException - if something goes wrong

    • setRequest

      public void setRequest​(javax.servlet.http.HttpServletRequest request)

    • getRequest

      public javax.servlet.http.HttpServletRequest getRequest()

    • reset

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

    • getErrorHandler

      public org.xml.sax.ErrorHandler getErrorHandler()
      Returns the errorHandler.
      Returns:
      the errorHandler

    • setErrorHandler

      public void setErrorHandler​(org.xml.sax.ErrorHandler errorHandler)
      Sets the errorHandler.
      Parameters:
      errorHandler - the errorHandler to set

    • getDocumentLocator

      public org.xml.sax.Locator getDocumentLocator()
      Returns the locator.
      Returns:
      the locator

    • setDocumentLocator

      public void setDocumentLocator​(org.xml.sax.Locator locator)
      Specified by:
      setDocumentLocator in interface org.xml.sax.ContentHandler
      See Also:
      ContentHandler.setDocumentLocator(org.xml.sax.Locator)

    • startDocument

      public void startDocument() throws org.xml.sax.SAXException
      Calls reset().
      Specified by:
      startDocument in interface org.xml.sax.ContentHandler
      Throws:
      org.xml.sax.SAXException
      See Also:
      ContentHandler.startDocument()

    • endDocument

      public void endDocument() throws org.xml.sax.SAXException
      Calls reset().
      Specified by:
      endDocument in interface org.xml.sax.ContentHandler
      Throws:
      org.xml.sax.SAXException
      See Also:
      ContentHandler.endDocument()

    • ignorableWhitespace

      public final void ignorableWhitespace​(char[] ch, int start, int length) throws org.xml.sax.SAXException
      Calls characters().
      Specified by:
      ignorableWhitespace in interface org.xml.sax.ContentHandler
      Throws:
      org.xml.sax.SAXException
      See Also:
      ContentHandler.ignorableWhitespace(char[], int, int)

    • characters

      public void characters​(char[] ch, int start, int length) throws org.xml.sax.SAXException
      Specified by:
      characters in interface org.xml.sax.ContentHandler
      Throws:
      org.xml.sax.SAXException
      See Also:
      ContentHandler.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
      Throws:
      org.xml.sax.SAXException
      See Also:
      ContentHandler.endElement(java.lang.String, java.lang.String, java.lang.String)

    • endPrefixMapping

      public void endPrefixMapping​(java.lang.String prefix) throws org.xml.sax.SAXException
      Specified by:
      endPrefixMapping in interface org.xml.sax.ContentHandler
      Throws:
      org.xml.sax.SAXException
      See Also:
      ContentHandler.endPrefixMapping(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
      Throws:
      org.xml.sax.SAXException
      See Also:
      ContentHandler.processingInstruction(java.lang.String, java.lang.String)

    • skippedEntity

      public void skippedEntity​(java.lang.String name) throws org.xml.sax.SAXException
      Specified by:
      skippedEntity in interface org.xml.sax.ContentHandler
      Throws:
      org.xml.sax.SAXException
      See Also:
      ContentHandler.skippedEntity(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
      Throws:
      org.xml.sax.SAXException
      See Also:
      ContentHandler.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
      Throws:
      org.xml.sax.SAXException
      See Also:
      ContentHandler.startPrefixMapping(java.lang.String, java.lang.String)