View Javadoc

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: MapGenerator.java,v 1.5 2005/08/26 18:10:10 mat007 Exp $
29   */
30  
31  package battlehex.model.command;
32  
33  import java.util.Iterator;
34  import jtge.util.grid.Coordinate;
35  import battlehex.model.map.ITileFactory;
36  import battlehex.model.player.IPlayer;
37  
38  /***
39   * Provides map random creation.
40   *
41   * @author Mathieu Champlon
42   * @version $Revision: 1.5 $ $Date: 2005/08/26 18:10:10 $
43   */
44  public class MapGenerator
45  {
46      private final ITileFactory factory;
47  
48      /***
49       * Create a map generator.
50       *
51       * @param factory the tile factory
52       */
53      public MapGenerator( final ITileFactory factory )
54      {
55          if( factory == null )
56              throw new IllegalArgumentException( "argument 'factory' is null" );
57          this.factory = factory;
58      }
59  
60      /***
61       * Iterate over coordinates and create tiles for given players according to the number per player specified.
62       *
63       * @param coordinatesIterator the coordinates to iterate over
64       * @param playersIterator the players to distribute the tiles among
65       * @param tilesPerPlayer the number of tiles per player
66       */
67      public final void populate( final Iterator coordinatesIterator, final Iterator playersIterator,
68              final int tilesPerPlayer )
69      {
70          while( playersIterator.hasNext() )
71              generate( coordinatesIterator, tilesPerPlayer, (IPlayer)playersIterator.next() );
72      }
73  
74      private void generate( final Iterator coordinatesIterator, final int tilesPerPlayer, final IPlayer player )
75      {
76          int tiles = tilesPerPlayer;
77          while( tiles-- > 0 && coordinatesIterator.hasNext() )
78              factory.create( (Coordinate)coordinatesIterator.next(), player );
79      }
80  }