View Javadoc

1   /*
2    *   Magic-Project is a turn based strategy simulator
3    *   Copyright (C) 2003-2007 Fabrice Daugan
4    *
5    *   This program is free software; you can redistribute it and/or modify it 
6    * under the terms of the GNU General Public License as published by the Free 
7    * Software Foundation; either version 2 of the License, or (at your option) any
8    * later version.
9    *
10   *   This program is distributed in the hope that it will be useful, but WITHOUT 
11   * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
12   * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more 
13   * details.
14   *
15   *   You should have received a copy of the GNU General Public License along  
16   * with this program; if not, write to the Free Software Foundation, Inc., 
17   * 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18   */
19  package net.sf.magicproject.token;
20  
21  import java.io.IOException;
22  import java.io.InputStream;
23  import java.io.OutputStream;
24  
25  /***
26   * @author <a href="mailto:fabdouglas@users.sourceforge.net">Fabrice Daugan </a>
27   * @since 0.85
28   */
29  public enum VisibilityChange {
30  
31  	/***
32  	 * The zone/card visibility is changed for the controller of this zone/card.
33  	 */
34  	controller,
35  
36  	/***
37  	 * The zone/card visibility is changed for the opponent of controller of this
38  	 * action.
39  	 */
40  	opponent,
41  
42  	/***
43  	 * The zone/card visibility is changed for you, the controller of this action.
44  	 */
45  	you,
46  
47  	/***
48  	 * The zone/card visibility is changed for everyone.
49  	 */
50  	everyone;
51  
52  	/***
53  	 * Wrtite this enum to the given outputstream.
54  	 * 
55  	 * @param out
56  	 *          the stream ths enum would be written.
57  	 * @throws IOException
58  	 *           If some other I/O error occurs
59  	 */
60  	public void serialize(OutputStream out) throws IOException {
61  		out.write(ordinal());
62  	}
63  
64  	/***
65  	 * Read and return the enum from the given inputstream.
66  	 * 
67  	 * @param input
68  	 *          the stream containing the enum to read.
69  	 * @return the enum from the given inputstream.
70  	 * @throws IOException
71  	 *           If some other I/O error occurs
72  	 */
73  	public static VisibilityChange deserialize(InputStream input)
74  			throws IOException {
75  		return values()[input.read()];
76  	}
77  
78  }