xmltooling/AttributeExtensibleXMLObject.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 AttributeExtensibleXMLObject.h\r
  19  * \r
  20  * An XMLObject that supports arbitrary attributes \r
  21  */\r
  22 \r
  23 #if !defined(__xmltooling_attrextxmlobj_h__)\r
  24 #define __xmltooling_attrextxmlobj_h__\r
  25 \r
  26 #include <xmltooling/XMLObject.h>\r
  27 \r
  28 using namespace xercesc;\r
  29 \r
  30 namespace xmltooling {\r
  31 \r
  32     /**\r
  33      * An XMLObject that supports arbitrary attributes.\r
  34      */\r
  35     class XMLTOOL_API AttributeExtensibleXMLObject : public virtual XMLObject\r
  36     {\r
  37     public:\r
  38         AttributeExtensibleXMLObject() {}\r
  39         virtual ~AttributeExtensibleXMLObject() {}\r
  40         \r
  41         /**\r
  42          * Gets the value of an XML attribute of the object\r
  43          * \r
  44          * @param   qualifiedName   qualified name of the attribute   \r
  45          * @return the attribute value, or NULL\r
  46          */\r
  47         virtual const XMLCh* getAttribute(QName& qualifiedName) const=0;\r
  48         \r
  49         /**\r
  50          * Sets (or clears) an XML attribute of the object \r
  51          * \r
  52          * @param qualifiedName qualified name of the attribute   \r
  53          * @param value         value to set, or NULL to clear\r
  54          */\r
  55         virtual void setAttribute(QName& qualifiedName, const XMLCh* value)=0;\r
  56     };\r
  57     \r
  58 };\r
  59 \r
  60 #endif /* __xmltooling_attrextxmlobj_h__ */\r