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.action.handler;
20  
21  import net.sf.magicproject.action.context.ActionContextWrapper;
22  import net.sf.magicproject.clickable.ability.Ability;
23  import net.sf.magicproject.event.context.ContextEventListener;
24  
25  /***
26   * Represent a rolbackable action that can also be simulated.
27   * 
28   * @author <a href="mailto:fabdouglas@users.sourceforge.net">Fabrice Daugan </a>
29   * @since 0.90
30   */
31  public interface FollowAction extends RollBackAction {
32  
33  	/***
34  	 * No generated event. Simulate an action. This action is considered as
35  	 * completed afterthis call, and th stack resolution should continue.
36  	 * 
37  	 * @param actionContext
38  	 *          the context containing data saved by this action during the
39  	 *          'choose" proceess.
40  	 * @param ability
41  	 *          is the ability owning this test. The card component of this
42  	 *          ability should correspond to the card owning this test too.
43  	 * @param context
44  	 *          is the context attached to this action.
45  	 */
46  	void simulate(ActionContextWrapper actionContext,
47  			ContextEventListener context, Ability ability);
48  
49  	/***
50  	 * No generated event. Rollback an action.
51  	 * 
52  	 * @param actionContext
53  	 *          the context containing data saved by this action during the
54  	 *          'choose" proceess.
55  	 * @param ability
56  	 *          is the ability owning this test. The card component of this
57  	 *          ability should correspond to the card owning this test too.
58  	 * @param context
59  	 *          is the context attached to this action.
60  	 */
61  	void rollback(ActionContextWrapper actionContext,
62  			ContextEventListener context, Ability ability);
63  
64  }