Xalan-C++ API Reference  1.12.0
XalanNodeList.hpp
Go to the documentation of this file.
1 /*
2  * Licensed to the Apache Software Foundation (ASF) under one
3  * or more contributor license agreements. See the NOTICE file
4  * distributed with this work for additional information
5  * regarding copyright ownership. The ASF licenses this file
6  * to you under the Apache License, Version 2.0 (the "License");
7  * you may not use this file except in compliance with the License.
8  * You may obtain a copy of the License at
9  *
10  * http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing, software
13  * distributed under the License is distributed on an "AS IS" BASIS,
14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15  * See the License for the specific language governing permissions and
16  * limitations under the License.
17  */
18 
19 #if !defined(XALANNODELIST_HEADER_GUARD_1357924680)
20 #define XALANNODELIST_HEADER_GUARD_1357924680
21 
22 
23 
24 #include "XalanDOMDefinitions.hpp"
25 
26 
27 
28 namespace XALAN_CPP_NAMESPACE {
29 
30 
31 
32 class XalanNode;
33 
34 
35 
37 {
38 public:
39 
40  XalanNodeList();
41 
42  virtual
43  ~XalanNodeList();
44 
45  /** @name Get functions. */
46  //@{
47  /**
48  * Returns the <code>index</code>th item in the collection.
49  *
50  * If <code>index</code> is greater than or equal to the number of nodes in
51  * the list, this returns <code>null</code>.
52  *
53  * @param index Index into the collection.
54  * @return The node at the <code>index</code>th position in the
55  * <code>NodeList</code>, or <code>null</code> if that is not a valid
56  * index.
57  */
58  virtual XalanNode*
59  item(XalanSize_t index) const = 0;
60 
61  /**
62  * Returns the number of nodes in the list.
63  *
64  * The range of valid child node indices is 0 to <code>length-1</code> inclusive.
65  */
66  virtual XalanSize_t
67  getLength() const = 0;
68 
69 protected:
70 
71  XalanNodeList(const XalanNodeList& theSource);
72 
74  operator=(const XalanNodeList& theSource);
75 
76  bool
77  operator==(const XalanNodeList& theRHS) const;
78 
79 private:
80 };
81 
82 
83 
84 }
85 
86 
87 
88 #endif // XALANNODELIST_HEADER_GUARD_1357924680
XALAN_CPP_NAMESPACE
#define XALAN_CPP_NAMESPACE
Xalan-C++ namespace, including major and minor version.
Definition: XalanVersion.hpp:76
xalanc::XalanNode
Definition: XalanNode.hpp:38
xalanc::operator==
bool operator==(const XalanVector< Type > &theLHS, const XalanVector< Type > &theRHS)
Definition: XalanVector.hpp:1118
xalanc::XalanNodeList
Definition: XalanNodeList.hpp:36
XalanDOMDefinitions.hpp
XALAN_DOM_EXPORT
#define XALAN_DOM_EXPORT
Definition: XalanDOMDefinitions.hpp:37