xmltooling/validation/Validator.h

   1 /*
   2  *  Copyright 2001-2009 Internet2
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 /**
  18  * @file xmltooling/validation/Validator.h
  19  *
  20  * Rules checking of XMLObjects.
  21  */
  22
  23 #ifndef __xmltooling_validator_h__
  24 #define __xmltooling_validator_h__
  25
  26 #include <xmltooling/XMLObject.h>
  27
  28 namespace xmltooling {
  29
  30     /**
  31      * An interface for classes that implement rules for checking the
  32      * validity of XMLObjects.
  33      */
  34     class XMLTOOL_API Validator
  35     {
  36     MAKE_NONCOPYABLE(Validator);
  37     public:
  38         virtual ~Validator();
  39
  40         /**
  41          * Checks to see if an XMLObject is valid.
  42          *
  43          * @param xmlObject the XMLObject to validate
  44
  45          * @throws ValidationException thrown if the element is not valid
  46          */
  47         virtual void validate(const XMLObject* xmlObject) const=0;
  48
  49     protected:
  50         Validator();
  51     };
  52
  53 };
  54
  55 #endif /* __xmltooling_validator_h__ */