1   /**
2    * Distribution License:
3    * JSword is free software; you can redistribute it and/or modify it under
4    * the terms of the GNU Lesser General Public License, version 2.1 or later
5    * as published by the Free Software Foundation. This program is distributed
6    * in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even
7    * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
8    * See the GNU Lesser General Public License for more details.
9    *
10   * The License is available on the internet at:
11   *      http://www.gnu.org/copyleft/lgpl.html
12   * or by writing to:
13   *      Free Software Foundation, Inc.
14   *      59 Temple Place - Suite 330
15   *      Boston, MA 02111-1307, USA
16   *
17   * © CrossWire Bible Society, 2005 - 2016
18   *
19   */
20  package org.crosswire.common.util;
21  
22  import java.util.Iterator;
23  import java.util.NoSuchElementException;
24  
25  /**
26   * An <code>EmptyIterator</code> is an <code>Iterator</code> that iterates over
27   * nothing.
28   * 
29   * @param <E> The type of the element that this empty iterator will never return.
30   * @see gnu.lgpl.License The GNU Lesser General Public License for details.
31   * @author DM Smith
32   */
33  public class EmptyIterator<E> implements Iterator<E> {
34  
35      /**
36       * Construct an <code>EmptyIterator</code>.
37       */
38      public EmptyIterator() {
39      }
40  
41      /* (non-Javadoc)
42       * @see java.util.Iterator#remove()
43       */
44      public void remove() {
45          throw new UnsupportedOperationException();
46      }
47  
48      /* (non-Javadoc)
49       * @see java.util.Iterator#hasNext()
50       */
51      public boolean hasNext() {
52          return false;
53      }
54  
55      /* (non-Javadoc)
56       * @see java.util.Iterator#next()
57       */
58      public E next() {
59          throw new NoSuchElementException();
60      }
61  
62  }
63