View Javadoc

1   /*
2    *  Copyright 2004 The Apache Software Foundation
3    *
4    *  Licensed under the Apache License, Version 2.0 (the "License");
5    *  you may not use this file except in compliance with the License.
6    *  You may obtain a copy of the License at
7    *
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    *
10   *  Unless required by applicable law or agreed to in writing, software
11   *  distributed under the License is distributed on an "AS IS" BASIS,
12   *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   *  See the License for the specific language governing permissions and
14   *  limitations under the License.
15   */
16  package net.sf.collections15.iterators;
17  
18  import java.util.Iterator;
19  
20  import net.sf.collections15.ResettableIterator;
21  
22  /*** 
23   * Provides an implementation of an empty iterator.
24   * <p>
25   * This class provides an implementation of an empty iterator.
26   * This class provides for binary compatability between Commons Collections
27   * 2.1.1 and 3.1 due to issues with <code>IteratorUtils</code>.
28   *
29   * @since Commons Collections 2.1.1 and 3.1
30   * @version $Revision: 1.1 $ $Date: 2005/02/27 18:48:37 $
31   * 
32   * @author Stephen Colebourne
33   * @author Mauro Franceschini (porto to 5.0)
34   */
35  public class EmptyIterator<E>
36      extends AbstractEmptyIterator<E>
37      implements ResettableIterator<E> {
38  
39      /***
40       * Singleton instance of the iterator.
41       * @since Commons Collections 3.1
42       */
43      public static final ResettableIterator RESETTABLE_INSTANCE =
44          new EmptyIterator();
45      
46      /***
47       * Singleton instance of the iterator.
48       * @since Commons Collections 2.1.1 and 3.1
49       */
50      public static final Iterator INSTANCE = RESETTABLE_INSTANCE;
51  
52      /***
53       * Constructor.
54       */
55      protected EmptyIterator() {
56          super();
57      }
58  
59  }