Some root interfaces and configuration machinery
[shibboleth/cpp-xmltooling.git] / xmltooling / XMLObjectBuilder.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 XMLObjectBuilder.h\r
19  * \r
20  * Factory interface for XMLObjects \r
21  */\r
22 \r
23 #if !defined(__xmltooling_xmlobjbuilder_h__)\r
24 #define __xmltooling_xmlobjbuilder_h__\r
25 \r
26 #include <xmltooling/XMLObject.h>\r
27 \r
28 namespace xmltooling {\r
29 \r
30     /**\r
31      * A factory interface for obtaining XMLObjects.\r
32      * Subclasses MAY supply additional factory methods.\r
33      */\r
34     class XMLTOOL_API XMLObjectBuilder\r
35     {\r
36     MAKE_NON_COPYABLE(XMLObjectBuilder);\r
37     public:\r
38         virtual ~XMLObjectBuilder() {}\r
39         \r
40         /**\r
41          * Creates an empty XMLObject.\r
42          * \r
43          * @return the empty XMLObject\r
44          */\r
45         public XMLObject* buildObject();\r
46     };\r
47 \r
48 };\r
49 \r
50 #endif /* __xmltooling_xmlobjbuilder_h__ */\r