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.zone;
20  
21  import java.io.IOException;
22  import java.io.InputStream;
23  
24  import net.sf.magicproject.test.Test;
25  import net.sf.magicproject.test.TestFactory;
26  import net.sf.magicproject.tools.MToolKit;
27  
28  /***
29   * @author <a href="mailto:fabdouglas@users.sourceforge.net">Fabrice Daugan </a>
30   * @since 0.93
31   */
32  public class SectorConfiguration {
33  
34  	/***
35  	 * The sector test.
36  	 */
37  	private final Test test;
38  
39  	/***
40  	 * The container constraint of this sector.
41  	 */
42  	private final Object constraint;
43  
44  	/***
45  	 * Create a new instance of this class.
46  	 * <ul>
47  	 * Structure of stream : Data[size]
48  	 * <li>sector test [Test]</li>
49  	 * <li>constraint [String]</li>
50  	 * </ul>
51  	 * 
52  	 * @param inputStream
53  	 *          the stream containing the layout configuration of this zone for a
54  	 *          specified layout
55  	 * @throws IOException
56  	 *           error during the configuration read.
57  	 */
58  	SectorConfiguration(InputStream inputStream) throws IOException {
59  		test = TestFactory.readNextTest(inputStream);
60  		constraint = MToolKit.readString(inputStream);
61  	}
62  
63  	/***
64  	 * The container constraint of this sector.
65  	 * 
66  	 * @return The container constraint of this sector.
67  	 */
68  	public Object getConstraint() {
69  		return this.constraint;
70  	}
71  
72  	/***
73  	 * The sector test.
74  	 * 
75  	 * @return The sector test.
76  	 */
77  	public Test getTest() {
78  		return this.test;
79  	}
80  
81  }