1 /****************************************************************************
3 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
4 ** All rights reserved.
5 ** Contact: Nokia Corporation (qt-info@nokia.com)
7 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
9 ** $QT_BEGIN_LICENSE:LGPL$
10 ** GNU Lesser General Public License Usage
11 ** This file may be used under the terms of the GNU Lesser General Public
12 ** License version 2.1 as published by the Free Software Foundation and
13 ** appearing in the file LICENSE.LGPL included in the packaging of this
14 ** file. Please review the following information to ensure the GNU Lesser
15 ** General Public License version 2.1 requirements will be met:
16 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
18 ** In addition, as a special exception, Nokia gives you certain additional
19 ** rights. These rights are described in the Nokia Qt LGPL Exception
20 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
22 ** GNU General Public License Usage
23 ** Alternatively, this file may be used under the terms of the GNU General
24 ** Public License version 3.0 as published by the Free Software Foundation
25 ** and appearing in the file LICENSE.GPL included in the packaging of this
26 ** file. Please review the following information to ensure the GNU General
27 ** Public License version 3.0 requirements will be met:
28 ** http://www.gnu.org/copyleft/gpl.html.
31 ** Alternatively, this file may be used in accordance with the terms and
32 ** conditions contained in a signed written agreement between you and Nokia.
40 ****************************************************************************/
46 // This file is not part of the Qt API. It exists purely as an
47 // implementation detail. This header file may change from version to
48 // version without notice, or even be removed.
52 #ifndef Patternist_EmptyIterator_H
53 #define Patternist_EmptyIterator_H
55 #include "qabstractxmlforwarditerator_p.h"
56 #include "qprimitives_p.h"
66 * @short An QAbstractXmlForwardIterator which always is empty.
68 * EmptyIterator is an QAbstractXmlForwardIterator over the type @c T, which always is empty. Other
69 * iterators can also be empty(or, at least behave as they are empty), but this
70 * class is special designed for this purpose and is therefore fast.
72 * EmptyIterator's constructor is protected, instances is retrieved from CommonValues.
74 * @author Frans Englich <frans.englich@nokia.com>
75 * @ingroup Patternist_iterators
77 template<typename T> class EmptyIterator : public QAbstractXmlForwardIterator<T>
81 * @returns always a default constructed value, T().
89 * @returns always a default constructed value, T().
91 virtual T current() const
99 virtual xsInteger position() const
105 * @returns always @c this, the reverse of <tt>()</tt> is <tt>()</tt>.
107 virtual typename QAbstractXmlForwardIterator<T>::Ptr toReversed()
109 return typename QAbstractXmlForwardIterator<T>::Ptr(const_cast<EmptyIterator<T> *>(this));
115 virtual xsInteger count()
123 virtual typename QAbstractXmlForwardIterator<T>::Ptr copy() const
125 return typename QAbstractXmlForwardIterator<T>::Ptr(const_cast<EmptyIterator *>(this));
129 friend class CommonValues;
134 typename QAbstractXmlForwardIterator<T>::Ptr
137 return typename QAbstractXmlForwardIterator<T>::Ptr(new EmptyIterator<T>());