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.93
28   */
29  public enum TrueFalseAuto {
30  
31  	/***
32  	 * 
33  	 */
34  	TRUE("true"),
35  
36  	/***
37  	 * 
38  	 */
39  	FALSE("false"),
40  
41  	/***
42  	 * 
43  	 */
44  	AUTO("auto");
45  
46  	private final String xsdName;
47  
48  	private TrueFalseAuto(String xsdName) {
49  		this.xsdName = xsdName;
50  	}
51  
52  	/***
53  	 * Return null of enum value corresponding to the given Xsd name.
54  	 * 
55  	 * @param xsdName
56  	 *          the Xsd name of this Aabstract value.
57  	 * @return null of enum value corresponding to the given Xsd name.
58  	 */
59  	public static TrueFalseAuto valueOfXsd(String xsdName) {
60  		if (xsdName == null)
61  			return AUTO;
62  		for (TrueFalseAuto value : values()) {
63  			if (value.xsdName.equals(xsdName)) {
64  				return value;
65  			}
66  		}
67  		return null;
68  	}
69  
70  	/***
71  	 * Write this enum to the given outputstream.
72  	 * 
73  	 * @param out
74  	 *          the stream ths enum would be written.
75  	 * @throws IOException
76  	 *           If some other I/O error occurs
77  	 */
78  	public void serialize(OutputStream out) throws IOException {
79  		out.write(ordinal());
80  	}
81  
82  	/***
83  	 * Read and return the enum from the given inputstream.
84  	 * 
85  	 * @param input
86  	 *          the stream containing the enum to read.
87  	 * @return the enum from the given inputstream.
88  	 * @throws IOException
89  	 *           If some other I/O error occurs
90  	 */
91  	public static TrueFalseAuto deserialize(InputStream input) throws IOException {
92  		return values()[input.read()];
93  	}
94  
95  	/***
96  	 * The associated boolean value.
97  	 * 
98  	 * @return the associated boolean value.
99  	 */
100 	public boolean getValue() {
101 		switch (this) {
102 		case TRUE:
103 			return true;
104 		case FALSE:
105 			return false;
106 		default:
107 			return true;
108 		}
109 	}
110 }