xercesc/dom/DOMImplementationList.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_DOMIMPLEMENTATIONLIST_HPP)
0023 #define XERCESC_INCLUDE_GUARD_DOMIMPLEMENTATIONLIST_HPP
0024
0025 #include <xercesc/util/XercesDefs.hpp>
0026
0027 XERCES_CPP_NAMESPACE_BEGIN
0028
0029
0030 class DOMImplementation;
0031
0032
0033 /**
0034  * The <code>DOMImplementationList</code> interface provides the abstraction of an ordered
0035  * collection of DOM implementations, without defining or constraining how this collection
0036  * is implemented. The items in the <code>DOMImplementationList</code> are accessible via
0037  * an integral index, starting from 0.
0038  */
0039
0040 class  CDOM_EXPORT DOMImplementationList {
0041 protected:
0042     // -----------------------------------------------------------------------
0043     //  Hidden constructors
0044     // -----------------------------------------------------------------------
0045     /** @name Hidden constructors */
0046     //@{
0047     DOMImplementationList() {};
0048     //@}
0049
0050 private:
0051     // -----------------------------------------------------------------------
0052     // Unimplemented constructors and operators
0053     // -----------------------------------------------------------------------
0054     /** @name Unimplemented constructors and operators */
0055     //@{
0056     DOMImplementationList(const DOMImplementationList &);
0057     DOMImplementationList & operator = (const DOMImplementationList &);
0058     //@}
0059
0060 public:
0061     // -----------------------------------------------------------------------
0062     //  All constructors are hidden, just the destructor is available
0063     // -----------------------------------------------------------------------
0064     /** @name Destructor */
0065     //@{
0066     /**
0067      * Destructor
0068      *
0069      */
0070     virtual ~DOMImplementationList()  {};
0071     //@}
0072
0073     // -----------------------------------------------------------------------
0074     //  Virtual DOMImplementationList interface
0075     // -----------------------------------------------------------------------
0076     /** @name Functions introduced in DOM Level 3 */
0077     //@{
0078     // -----------------------------------------------------------------------
0079     //  Getter methods
0080     // -----------------------------------------------------------------------
0081     /**
0082      * Returns the <code>index</code> item in the collection.
0083      *
0084      * If <code>index</code> is greater than or equal to the number of DOMImplementation in
0085      * the list, this returns <code>null</code>.
0086      *
0087      * @param index Index into the collection.
0088      * @return The DOMImplementation at the <code>index</code>th position in the
0089      *   <code>DOMImplementationList</code>, or <code>null</code> if that is not a valid
0090      *   index.
0091      * @since DOM Level 3
0092      */
0093     virtual DOMImplementation *item(XMLSize_t index) const = 0;
0094
0095     /**
0096      * Returns the number of DOMImplementation in the list.
0097      *
0098      * The range of valid child node indices is 0 to <code>length-1</code> inclusive.
0099      * @since DOM Level 3
0100      */
0101     virtual XMLSize_t getLength() const = 0;
0102     //@}
0103
0104     // -----------------------------------------------------------------------
0105     //  Non-standard Extension
0106     // -----------------------------------------------------------------------
0107     /** @name Non-standard Extension */
0108     //@{
0109     /**
0110      * Called to indicate that this list is no longer in use
0111      * and that the implementation may relinquish any resources associated with it and
0112      * its associated children.
0113      *
0114      * Access to a released object will lead to unexpected result.
0115      *
0116      */
0117     virtual void release() = 0;
0118     //@}
0119
0120 };
0121
0122 XERCES_CPP_NAMESPACE_END
0123
0124 #endif