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.test;
20  
21  import java.io.IOException;
22  import java.io.InputStream;
23  
24  import net.sf.magicproject.clickable.ability.Ability;
25  import net.sf.magicproject.clickable.targetable.Targetable;
26  import net.sf.magicproject.stack.StackManager;
27  import net.sf.magicproject.tools.MToolKit;
28  
29  /***
30   * Test if the ability generating the current event has the specified name. This
31   * test should used only in activation test of a triggered event.
32   * 
33   * @author <a href="mailto:fabdouglas@users.sourceforge.net">Fabrice Daugan </a>
34   * @since 0.86
35   */
36  public class AbilitySource extends Test {
37  
38  	/***
39  	 * Create an instance of AbilitySource by reading a file. Offset's file must
40  	 * pointing on the first byte of this test <br>
41  	 * <ul>
42  	 * Structure of InputStream : Data[size]
43  	 * <li>idTest [1]</li>
44  	 * <li>ability name +'\0' [...]</li>
45  	 * </ul>
46  	 * 
47  	 * @param inputFile
48  	 *          is the file containing this event
49  	 * @throws IOException
50  	 *           if error occurred during the reading process from the specified
51  	 *           input stream
52  	 */
53  	AbilitySource(InputStream inputFile) throws IOException {
54  		super(inputFile);
55  		abilityName = MToolKit.readString(inputFile).intern();
56  	}
57  
58  	@Override
59  	public boolean test(Ability ability, Targetable tested) {
60  		return abilityName.equals(StackManager.currentAbility.getName());
61  	}
62  
63  	/***
64  	 * The ability's name to be compared to
65  	 */
66  	private final String abilityName;
67  
68  }