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: AbstractContext.java,v 1.3 2005/08/26 18:09:35 mat007 Exp $
29   */
30  
31  package jtge.engine.data;
32  
33  /***
34   * Captures common context behaviours.
35   * <p>
36   * FIXME refactor with battlehex turn management.
37   *
38   * @author Mathieu Champlon
39   * @version $Revision: 1.3 $ $Date: 2005/08/26 18:09:35 $
40   */
41  public abstract class AbstractContext implements IContext
42  {
43      private final String name;
44      private int turn;
45  
46      /***
47       * Create a context.
48       *
49       * @param name the game name.
50       */
51      public AbstractContext( final String name )
52      {
53          this.name = name;
54          this.turn = 0;
55      }
56  
57      /***
58       * Get the context name.
59       *
60       * @return the context name
61       */
62      public final String getName()
63      {
64          return this.name;
65      }
66  
67      /***
68       * Get the current turn.
69       *
70       * @return the context turn
71       */
72      public final int getTurn()
73      {
74          return this.turn;
75      }
76  
77      /***
78       * Increments the current turn.
79       */
80      public final void nextTurn()
81      {
82          this.turn++;
83      }
84  
85      /***
86       * Turn start event.
87       */
88      protected abstract void turnStarted();
89  
90      /***
91       * Turn end event.
92       */
93      protected abstract void turnEnded();
94  }