View Javadoc

1   /**
2    * This file Copyright (c) 2011 Magnolia International
3    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10   * This file is distributed in the hope that it will be
11   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12   * implied warranty of MERCHANTABILITY or FITNESS FOR A
13   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14   * Redistribution, except as permitted by whichever of the GPL
15   * or MNA you select, is prohibited.
16   *
17   * 1. For the GPL license (GPL), you can redistribute and/or
18   * modify this file under the terms of the GNU General
19   * Public License, Version 3, as published by the Free Software
20   * Foundation.  You should have received a copy of the GNU
21   * General Public License, Version 3 along with this program;
22   * if not, write to the Free Software Foundation, Inc., 51
23   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24   *
25   * 2. For the Magnolia Network Agreement (MNA), this file
26   * and the accompanying materials are made available under the
27   * terms of the MNA which accompanies this distribution, and
28   * is available at http://www.magnolia-cms.com/mna.html
29   *
30   * Any modifications to this file must keep this entire header
31   * intact.
32   *
33   */
34  package info.magnolia.jcr.iterator;
35  
36  import java.util.Collection;
37  import java.util.Iterator;
38  import javax.jcr.RangeIterator;
39  
40  /**
41   * Intended as a base class when implementing JCR iterators, sub-classes need only implement the special next methods
42   * such as nextNode() for NodeIterator.
43   *
44   * @param <T>
45   * @version $Id$
46   */
47  public class RangeIteratorImpl<T> implements RangeIterator {
48  
49      private final Iterator<T> iterator;
50      private final long size;
51      private long position = 0;
52  
53      public RangeIteratorImpl(Collection<T> collection) {
54          this.iterator = collection.iterator();
55          this.size = collection.size();
56      }
57  
58      public RangeIteratorImpl(RangeIterator rangeIterator) {
59          this.iterator = rangeIterator;
60          this.size = rangeIterator.getSize();
61          this.position = rangeIterator.getPosition();
62      }
63  
64      public RangeIteratorImpl(Iterator<T> iterator, int size) {
65          this.iterator = iterator;
66          this.size = size;
67      }
68  
69      @Override
70      public void skip(long skipNum) {
71          while (skipNum > 0) {
72              next();
73              skipNum--;
74          }
75      }
76  
77      @Override
78      public long getSize() {
79          return size;
80      }
81  
82      @Override
83      public long getPosition() {
84          return position;
85      }
86  
87      @Override
88      public boolean hasNext() {
89          return iterator.hasNext();
90      }
91  
92      @Override
93      public T next() {
94          return nextElement();
95      }
96  
97      @Override
98      public void remove() {
99          iterator.remove();
100     }
101 
102     protected T nextElement() {
103         T element = iterator.next();
104         position++;
105         return element;
106     }
107 }