xercesc/dom/DOMImplementationRegistry.hpp

0001 /*
0002  * Licensed to the Apache Software Foundation (ASF) under one or more
0003  * contributor license agreements.  See the NOTICE file distributed with
0004  * this work for additional information regarding copyright ownership.
0005  * The ASF licenses this file to You under the Apache License, Version 2.0
0006  * (the "License"); you may not use this file except in compliance with
0007  * the License.  You may obtain a copy of the License at
0008  *
0009  *      http://www.apache.org/licenses/LICENSE-2.0
0010  *
0011  * Unless required by applicable law or agreed to in writing, software
0012  * distributed under the License is distributed on an "AS IS" BASIS,
0013  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
0014  * See the License for the specific language governing permissions and
0015  * limitations under the License.
0016  */
0017
0018 /*
0019  * $Id$
0020  */
0021
0022 #if !defined(XERCESC_INCLUDE_GUARD_DOMIMPLEMENTATIONREGISTRY_HPP)
0023 #define XERCESC_INCLUDE_GUARD_DOMIMPLEMENTATIONREGISTRY_HPP
0024
0025  /**
0026   * This class holds the list of registered DOMImplementations.  Implementation
0027   * or application can register DOMImplementationSource to the registry, and
0028   * then can query DOMImplementation based on a list of requested features.
0029   *
0030   * <p>This provides an application with an implementation independent starting
0031   * point.
0032   *
0033   * @see DOMImplementation
0034   * @see DOMImplementationList
0035   * @see DOMImplementationSource
0036   * @since DOM Level 3
0037   */
0038
0039 #include <xercesc/util/XercesDefs.hpp>
0040
0041 XERCES_CPP_NAMESPACE_BEGIN
0042
0043
0044 class DOMImplementation;
0045 class DOMImplementationSource;
0046 class DOMImplementationList;
0047
0048 class CDOM_EXPORT DOMImplementationRegistry
0049 {
0050 public:
0051     // -----------------------------------------------------------------------
0052     //  Static DOMImplementationRegistry interface
0053     // -----------------------------------------------------------------------
0054     /** @name Functions introduced in DOM Level 3 */
0055     //@{
0056     /**
0057      * Return the first registered implementation that has the desired features,
0058      * or null if none is found.
0059      *
0060      * @param features A string that specifies which features are required.
0061      *                 This is a space separated list in which each feature is
0062      *                 specified by its name optionally followed by a space
0063      *                 and a version number.
0064      *                 This is something like: "XML 1.0 Traversal 2.0"
0065      * @return An implementation that has the desired features, or
0066      *   <code>null</code> if this source has none.
0067      * @since DOM Level 3
0068      */
0069     static DOMImplementation* getDOMImplementation(const XMLCh* features);
0070
0071     /**
0072      * Return the list of registered implementation that have the desired features.
0073      *
0074      * @param features A string that specifies which features are required.
0075      *                 This is a space separated list in which each feature is
0076      *                 specified by its name optionally followed by a space
0077      *                 and a version number.
0078      *                 This is something like: "XML 1.0 Traversal 2.0"
0079      * @return A DOMImplementationList object that contains the DOMImplementation
0080      *         that have the desired features
0081      * @since DOM Level 3
0082      */
0083     static DOMImplementationList* getDOMImplementationList(const XMLCh* features);
0084
0085     /**
0086      * Register an implementation.
0087      *
0088      * @param source   A DOMImplementation Source object to be added to the registry.
0089      *                 The registry does NOT adopt the source object.  Users still own it.
0090      * @since DOM Level 3
0091      */
0092     static void addSource(DOMImplementationSource* source);
0093     //@}
0094
0095 private:
0096     DOMImplementationRegistry();
0097 };
0098
0099 XERCES_CPP_NAMESPACE_END
0100
0101 #endif