xmltooling/validation/Validator.h

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