View Javadoc

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