xmltooling/ElementExtensibleXMLObject.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/ElementExtensibleXMLObject.h
  23  *
  24  * An XMLObject that exposes arbitrary children via a mutable vector.
  25  */
  26
  27 #ifndef __xmltooling_eleextxmlobj_h__
  28 #define __xmltooling_eleextxmlobj_h__
  29
  30 #include <xmltooling/XMLObject.h>
  31 #include <xmltooling/util/XMLObjectChildrenList.h>
  32
  33 #if defined (_MSC_VER)
  34     #pragma warning( push )
  35     #pragma warning( disable : 4250 4251 )
  36 #endif
  37
  38 namespace xmltooling {
  39
  40     /**
  41      * An XMLObject that exposes arbitrary children via a mutable vector.
  42      */
  43     class XMLTOOL_API ElementExtensibleXMLObject : public virtual XMLObject
  44     {
  45     protected:
  46         ElementExtensibleXMLObject();
  47
  48     public:
  49         virtual ~ElementExtensibleXMLObject();
  50
  51         /**
  52          * Gets a mutable list of child objects
  53          *
  54          * @return  mutable list of child objects
  55          */
  56         virtual VectorOf(XMLObject) getUnknownXMLObjects()=0;
  57
  58         /**
  59          * Gets an immutable list of child objects
  60          *
  61          * @return  immutable list of child objects
  62          */
  63         virtual const std::vector<XMLObject*>& getUnknownXMLObjects() const=0;
  64     };
  65
  66 };
  67
  68 #if defined (_MSC_VER)
  69     #pragma warning( pop )
  70 #endif
  71
  72 #endif /* __xmltooling_eleextxmlobj_h__ */