source: icXML/icXML-devel/src/xercesc/dom/DOMImplementationList.hpp @ 2722

Last change on this file since 2722 was 2722, checked in by cameron, 6 years ago

Original Xerces files with import mods for icxercesc

File size: 4.3 KB
Line 
1/*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements.  See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License.  You may obtain a copy of the License at
8 *
9 *      http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18/*
19 * $Id: DOMImplementationList.hpp 671894 2008-06-26 13:29:21Z borisk $
20 */
21
22#if !defined(XERCESC_INCLUDE_GUARD_DOMIMPLEMENTATIONLIST_HPP)
23#define XERCESC_INCLUDE_GUARD_DOMIMPLEMENTATIONLIST_HPP
24
25#include <xercesc/util/XercesDefs.hpp>
26
27XERCES_CPP_NAMESPACE_BEGIN
28
29
30class DOMImplementation;
31
32
33/**
34 * The <code>DOMImplementationList</code> interface provides the abstraction of an ordered
35 * collection of DOM implementations, without defining or constraining how this collection
36 * is implemented. The items in the <code>DOMImplementationList</code> are accessible via
37 * an integral index, starting from 0.
38 */
39
40class  CDOM_EXPORT DOMImplementationList {
41protected:
42    // -----------------------------------------------------------------------
43    //  Hidden constructors
44    // -----------------------------------------------------------------------
45    /** @name Hidden constructors */
46    //@{
47    DOMImplementationList() {};
48    //@}
49
50private:
51    // -----------------------------------------------------------------------
52    // Unimplemented constructors and operators
53    // -----------------------------------------------------------------------
54    /** @name Unimplemented constructors and operators */
55    //@{
56    DOMImplementationList(const DOMImplementationList &);
57    DOMImplementationList & operator = (const DOMImplementationList &);
58    //@}
59
60public:
61    // -----------------------------------------------------------------------
62    //  All constructors are hidden, just the destructor is available
63    // -----------------------------------------------------------------------
64    /** @name Destructor */
65    //@{
66    /**
67     * Destructor
68     *
69     */
70    virtual ~DOMImplementationList()  {};
71    //@}
72
73    // -----------------------------------------------------------------------
74    //  Virtual DOMImplementationList interface
75    // -----------------------------------------------------------------------
76    /** @name Functions introduced in DOM Level 3 */
77    //@{
78    // -----------------------------------------------------------------------
79    //  Getter methods
80    // -----------------------------------------------------------------------
81    /**
82     * Returns the <code>index</code> item in the collection.
83     *
84     * If <code>index</code> is greater than or equal to the number of DOMImplementation in
85     * the list, this returns <code>null</code>.
86     *
87     * @param index Index into the collection.
88     * @return The DOMImplementation at the <code>index</code>th position in the
89     *   <code>DOMImplementationList</code>, or <code>null</code> if that is not a valid
90     *   index.
91     * @since DOM Level 3
92     */
93    virtual DOMImplementation *item(XMLSize_t index) const = 0;
94
95    /**
96     * Returns the number of DOMImplementation in the list.
97     *
98     * The range of valid child node indices is 0 to <code>length-1</code> inclusive.
99     * @since DOM Level 3
100     */
101    virtual XMLSize_t getLength() const = 0;
102    //@}
103
104    // -----------------------------------------------------------------------
105    //  Non-standard Extension
106    // -----------------------------------------------------------------------
107    /** @name Non-standard Extension */
108    //@{
109    /**
110     * Called to indicate that this list is no longer in use
111     * and that the implementation may relinquish any resources associated with it and
112     * its associated children.
113     *
114     * Access to a released object will lead to unexpected result.
115     *
116     */
117    virtual void release() = 0;
118    //@}
119
120};
121
122XERCES_CPP_NAMESPACE_END
123
124#endif
Note: See TracBrowser for help on using the repository browser.