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