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: Turn.java,v 1.5 2005/09/04 21:34:24 mat007 Exp $
29 */
30
31 package battlehex.model;
32
33 /***
34 * Encapsulates a turn counter.
35 * <p>
36 * This class implements immutable value objects.
37 *
38 * @author Mathieu Champlon
39 * @version $Revision: 1.5 $ $Date: 2005/09/04 21:34:24 $
40 */
41 public class Turn
42 {
43 private static final int START_TURN_NUMBER = 0;
44 private int turn;
45
46 /***
47 * Create a turn.
48 */
49 public Turn()
50 {
51 turn = START_TURN_NUMBER;
52 }
53
54 private Turn( final int turn )
55 {
56 this.turn = turn;
57 }
58
59 /***
60 * Increment the turn number.
61 *
62 * @return the next turn
63 */
64 public final Turn next()
65 {
66 return new Turn( turn + 1 );
67 }
68
69 /***
70 * {@inheritDoc}
71 */
72 public final String toString()
73 {
74 return String.valueOf( turn );
75 }
76 }