1 /***
2 * Redistribution and use in source and binary forms, with or without
3 * modification, are permitted provided that the following conditions are
4 * met :
5 *
6 * . Redistributions of source code must retain the above copyright
7 * notice, this list of conditions and the following disclaimer.
8 *
9 * . Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 *
13 * . The name of the author may not be used to endorse or promote products
14 * derived from this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19 * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
20 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
22 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
24 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
25 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26 * POSSIBILITY OF SUCH DAMAGE.
27 *
28 * $Id: LinearIterator.java,v 1.2 2005/09/09 18:19:41 mat007 Exp $
29 */
30
31 package jtge.util.grid;
32
33 import java.util.Iterator;
34 import java.util.NoSuchElementException;
35
36 /***
37 * Provides a linear iterator from top left to bottom right coordinate.
38 *
39 * @author Jean-Laurent Fabre de Morlhon
40 * @version $Id: LinearIterator.java,v 1.2 2005/09/09 18:19:41 mat007 Exp $
41 */
42 public class LinearIterator implements Iterator
43 {
44 private final IGrid grid;
45 private Coordinate next;
46
47 /***
48 * Create a linear coordinate iterator.
49 *
50 * @param grid the grid
51 */
52 public LinearIterator( final IGrid grid )
53 {
54 this( grid, new Coordinate( 0, 0 ) );
55 }
56
57 /***
58 * Create a linear tile iterator starting from a given coordinate.
59 *
60 * @param grid the grid
61 * @param coordinate the starting coordinate
62 */
63 public LinearIterator( final IGrid grid, final Coordinate coordinate )
64 {
65 if( !grid.isValid( coordinate ) )
66 throw new OutOfBoundException( coordinate );
67 this.grid = grid;
68 this.next = coordinate;
69 }
70
71 /***
72 * {@inheritDoc}
73 */
74 public final boolean hasNext()
75 {
76 return next.getY() < grid.getHeight();
77 }
78
79 /***
80 * {@inheritDoc}
81 */
82 public final Object next()
83 {
84 if( !hasNext() )
85 throw new NoSuchElementException( "iterator exhausted" );
86 final Coordinate result = (Coordinate)next.clone();
87 increment( next );
88 return result;
89 }
90
91 private void increment( final Coordinate coordinate )
92 {
93 coordinate.setX( coordinate.getX() + 1 );
94 if( coordinate.getX() == grid.getWidth() )
95 {
96 coordinate.setY( coordinate.getY() + 1 );
97 coordinate.setX( 0 );
98 }
99 }
100
101 /***
102 * {@inheritDoc}
103 */
104 public final void remove()
105 {
106 throw new UnsupportedOperationException();
107 }
108 }