be6f101af7311fef83833f24b6155686c62baf7e
[shibboleth/cpp-xmltooling.git] / xmltooling / ConcreteXMLObjectBuilder.h
1 /*
2  *  Copyright 2001-2009 Internet2
3  * 
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 /**
18  * @file xmltooling/ConcreteXMLObjectBuilder.h
19  * 
20  * Factory interface for concrete XMLObjects, supporting default construction. 
21  */
22
23 #ifndef __xmltooling_concxmlobjbuilder_h__
24 #define __xmltooling_concxmlobjbuilder_h__
25
26 #include <xmltooling/XMLObjectBuilder.h>
27
28 namespace xmltooling {
29
30     /**
31      * A factory interface for obtaining XMLObjects.
32      * Subclasses MAY supply additional factory methods.
33      */
34     class XMLTOOL_API ConcreteXMLObjectBuilder : public XMLObjectBuilder
35     {
36     public:
37         virtual ~ConcreteXMLObjectBuilder();
38
39         using XMLObjectBuilder::buildObject;
40         
41         /**
42          * Creates an empty XMLObject with a defaulted element name and/or type.
43          * 
44          * @return the empty XMLObject
45          */
46         virtual XMLObject* buildObject() const=0;
47
48     protected:
49         ConcreteXMLObjectBuilder();
50     };
51
52 };
53
54 #endif /* __xmltooling_concxmlobjbuilder_h__ */