xmltooling/validation/Validator.h

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