1 // START LICENSE
2 // JSet - a Java JSet card board game implementation
3 // Copyright (C) 2004 Jerome Lacoste
4 //
5 // This program is free software; you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation; either version 2 of the License, or (at
8 // your option) any later version.
9 //
10 // This program is distributed in the hope that it will be useful, but
11 // WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 // General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with this program; if not, write to the Free Software
17 // Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
18 // END LICENSE
19
20 package org.cb.jset.client;
21
22 /***
23 * Represents game events, including {@link #START start} and {@link #END end}.
24 *
25 * @author jerome@coffeebreaks.org - last modified by $LastChangedBy: jerome $
26 * @version $Id: GameEvent.java 123 2004-04-14 23:45:53Z jerome $
27 * @todo start -> stop and begin -> end. Am I not mixing it all here?
28 */
29 public class GameEvent
30 {
31 /*** Used to identify game starts. */
32 public static final int START = 1;
33 /*** Used to identify game ends. */
34 public static final int END = 0;
35
36 /*** the type of the event. */
37 private final int _type;
38
39 /***
40 * Constructs a game event given the specified type.
41 * @param type the type of the event.
42 */
43 public GameEvent(final int type)
44 {
45 _type = type;
46 }
47
48 /***
49 * @return the type of the event.
50 */
51 public int getType()
52 {
53 return _type;
54 }
55 }