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: Tile.java,v 1.7 2005/08/26 18:10:08 mat007 Exp $
29   */
30  
31  package battlehex.model.map;
32  
33  import java.awt.Color;
34  
35  /***
36   * Implements tile logics.
37   *
38   * @author Mathieu Champlon
39   * @version $Revision: 1.7 $ $Date: 2005/08/26 18:10:08 $
40   */
41  public class Tile implements ITile
42  {
43      private final ISurrounding surrounding;
44      private ITerritory territory;
45      private IEntity entity;
46  
47      /***
48       * Create a tile.
49       *
50       * @param surrounding the tile surrounding
51       * @param territory the tile territory
52       */
53      public Tile( final ISurrounding surrounding, final ITerritory territory )
54      {
55          if( surrounding == null )
56              throw new IllegalArgumentException( "argument 'surrounding' is null" );
57          if( territory == null )
58              throw new IllegalArgumentException( "argument 'territory' is null" );
59          this.surrounding = surrounding;
60          this.territory = territory;
61          this.territory.add( this );
62          surrounding.merge( territory );
63      }
64  
65      /***
66       * {@inheritDoc}
67       */
68      public final ITerritory getTerritory()
69      {
70          return territory;
71      }
72  
73      /***
74       * {@inheritDoc}
75       */
76      public final void setTerritory( final ITerritory territory )
77      {
78          if( territory != null && territory != this.territory )
79          {
80              final ITerritory previous = this.territory;
81              this.territory = territory;
82              previous.transfer( this, territory );
83              surrounding.merge( territory );
84          }
85      }
86  
87      /***
88       * {@inheritDoc}
89       */
90      public final void capture( final ITile tile )
91      {
92          if( tile != null )
93              tile.setTerritory( territory );
94      }
95  
96      /***
97       * Retrieve the entity in the tile.
98       *
99       * @return the entity in the tile or null if none
100      */
101     public final IEntity getEntity()
102     {
103         return entity;
104     }
105 
106     /***
107      * The color of the tile.
108      *
109      * @return a color
110      */
111     public final Color getColor()
112     {
113         return territory.getColor();
114     }
115 
116     /***
117      * {@inheritDoc}
118      */
119     public final String toString()
120     {
121         return surrounding.toString();
122     }
123 
124     /***
125      * {@inheritDoc}
126      */
127     public final boolean isNeighbour( final ITile tile )
128     {
129         return surrounding.isNeighbour( tile );
130     }
131 
132     /***
133      * {@inheritDoc}
134      */
135     public final void setEntity( final IEntity entity )
136     {
137         this.entity = entity;
138     }
139 }