Class VerifierImpl

  • All Implemented Interfaces:
    Verifier

    public abstract class VerifierImpl
    extends java.lang.Object
    implements Verifier
    Partial implementation of Verifier.

    This class is useful as the base class of the verifier implementation.

    The only remaining method that has to be implemented by the derived class is the getVerifierHandler method. Please be noted that applications can call the setErrorHandler method after the getVerifierHandler method and that change should take effect.

    Version:
    $Id: VerifierImpl.java,v 1.4 2003/05/30 23:46:33 kkawa Exp $
    Author:
    Kohsuke KAWAGUCHI
    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Object getProperty​(java.lang.String property)
      Gets a property value
      VerifierFilter getVerifierFilter()
      Gets a VerifierFilter.
      abstract VerifierHandler getVerifierHandler()
      Gets a VerifierHandler.
      boolean isFeature​(java.lang.String feature)
      Checks whether a feature is supported or not.
      void setEntityResolver​(org.xml.sax.EntityResolver resolver)
      Sets a EntityResolver to resolve external entity locations.
      void setErrorHandler​(org.xml.sax.ErrorHandler handler)
      Sets a ErrorHandler that receives validation errors/warnings.
      void setFeature​(java.lang.String feature, boolean value)
      Sets a value to a feature.
      void setProperty​(java.lang.String property, java.lang.Object value)
      Sets a property value
      boolean verify​(java.io.File f)
      validates an XML document.
      boolean verify​(java.lang.String uri)
      validates an XML document.
      boolean verify​(org.w3c.dom.Node node)
      validates an XML document.
      boolean verify​(org.xml.sax.InputSource source)
      validates an XML document.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Method Detail

      • isFeature

        public boolean isFeature​(java.lang.String feature)
                          throws org.xml.sax.SAXNotRecognizedException,
                                 org.xml.sax.SAXNotSupportedException
        Description copied from interface: Verifier
        Checks whether a feature is supported or not.

        This method is modeled after SAX2.

        Specified by:
        isFeature in interface Verifier
        Parameters:
        feature - feature name
        Throws:
        org.xml.sax.SAXNotRecognizedException
        org.xml.sax.SAXNotSupportedException
      • setFeature

        public void setFeature​(java.lang.String feature,
                               boolean value)
                        throws org.xml.sax.SAXNotRecognizedException,
                               org.xml.sax.SAXNotSupportedException
        Description copied from interface: Verifier
        Sets a value to a feature.

        This method is modeled after SAX2.

        Specified by:
        setFeature in interface Verifier
        Parameters:
        feature - feature name
        value - feature value
        Throws:
        org.xml.sax.SAXNotRecognizedException
        org.xml.sax.SAXNotSupportedException
      • getProperty

        public java.lang.Object getProperty​(java.lang.String property)
                                     throws org.xml.sax.SAXNotRecognizedException,
                                            org.xml.sax.SAXNotSupportedException
        Description copied from interface: Verifier
        Gets a property value

        This method is modeled after SAX2.

        Specified by:
        getProperty in interface Verifier
        Parameters:
        property - property name
        Throws:
        org.xml.sax.SAXNotRecognizedException
        org.xml.sax.SAXNotSupportedException
      • setProperty

        public void setProperty​(java.lang.String property,
                                java.lang.Object value)
                         throws org.xml.sax.SAXNotRecognizedException,
                                org.xml.sax.SAXNotSupportedException
        Description copied from interface: Verifier
        Sets a property value

        This method is modeled after SAX2.

        Specified by:
        setProperty in interface Verifier
        Parameters:
        property - property name
        value - property value
        Throws:
        org.xml.sax.SAXNotRecognizedException
        org.xml.sax.SAXNotSupportedException
      • setErrorHandler

        public void setErrorHandler​(org.xml.sax.ErrorHandler handler)
        Description copied from interface: Verifier
        Sets a ErrorHandler that receives validation errors/warnings.

        If no error handler is set explicitly, a verifier implementation will not report any error/warning at all. However, the caller can still obtain the result of validation through the return value.

        Conscious developers should always set an error handler explicitly as the default behavior has been changed several times.

        Specified by:
        setErrorHandler in interface Verifier
        Parameters:
        handler - this object will receive errors/warning encountered during the validation.
      • verify

        public boolean verify​(java.lang.String uri)
                       throws org.xml.sax.SAXException,
                              java.io.IOException
        Description copied from interface: Verifier
        validates an XML document.
        Specified by:
        verify in interface Verifier
        Parameters:
        uri - URI of a document.
        Returns:
        true if the document is valid. false if otherwise.
        Throws:
        org.xml.sax.SAXException
        java.io.IOException
      • verify

        public boolean verify​(org.xml.sax.InputSource source)
                       throws org.xml.sax.SAXException,
                              java.io.IOException
        Description copied from interface: Verifier
        validates an XML document.
        Specified by:
        verify in interface Verifier
        Parameters:
        source - InputSource of a XML document to verify.
        Returns:
        true if the document is valid. false if otherwise.
        Throws:
        org.xml.sax.SAXException
        java.io.IOException
      • verify

        public boolean verify​(java.io.File f)
                       throws org.xml.sax.SAXException,
                              java.io.IOException
        Description copied from interface: Verifier
        validates an XML document.
        Specified by:
        verify in interface Verifier
        Parameters:
        f - File to be validated
        Returns:
        true if the document is valid. false if otherwise.
        Throws:
        org.xml.sax.SAXException
        java.io.IOException
      • verify

        public boolean verify​(org.w3c.dom.Node node)
                       throws org.xml.sax.SAXException
        Description copied from interface: Verifier
        validates an XML document.

        An implementation is required to accept Document object as the node parameter. If it also implements partial validation, it can also accepts things like Element.

        Specified by:
        verify in interface Verifier
        Parameters:
        node - the root DOM node of an XML document.
        Returns:
        true if the document is valid. false if otherwise.
        Throws:
        org.xml.sax.SAXException
      • getVerifierHandler

        public abstract VerifierHandler getVerifierHandler()
                                                    throws org.xml.sax.SAXException
        Description copied from interface: Verifier
        Gets a VerifierHandler.

        you can use the returned VerifierHandler to validate documents through SAX.

        Note that two different invocations of this method can return the same value; this method does NOT necessarily create a new VerifierHandler object.

        Specified by:
        getVerifierHandler in interface Verifier
        Throws:
        org.xml.sax.SAXException
      • getVerifierFilter

        public VerifierFilter getVerifierFilter()
                                         throws org.xml.sax.SAXException
        Description copied from interface: Verifier
        Gets a VerifierFilter.

        you can use the returned VerifierHandler to validate documents through SAX.

        Note that two different invocations of this method can return the same value; this method does NOT necessarily create a new VerifierFilter object.

        Specified by:
        getVerifierFilter in interface Verifier
        Throws:
        org.xml.sax.SAXException