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.util.ArrayList;
22  import java.util.List;
23  
24  import net.sf.magicproject.clickable.targetable.card.AbstractCard;
25  import net.sf.magicproject.clickable.targetable.card.MCard;
26  import net.sf.magicproject.test.Test;
27  
28  /***
29   * @author <a href="mailto:fabdouglas@users.sourceforge.net">Fabrice Daugan </a>
30   * @since 0.93
31   */
32  public class ZoneSector {
33  
34  	private final List<AbstractCard> cards;
35  
36  	private final SectorConfiguration configuration;
37  
38  	/***
39  	 * Create a new instance of this class.
40  	 * 
41  	 * @param configuration
42  	 *          the sector configuration.
43  	 */
44  	ZoneSector(SectorConfiguration configuration) {
45  		this.configuration = configuration;
46  		cards = new ArrayList<AbstractCard>();
47  	}
48  
49  	/***
50  	 * The container constraint of this sector.
51  	 * 
52  	 * @return The container constraint of this sector.
53  	 */
54  	public Object getConstraint() {
55  		return this.configuration.getConstraint();
56  	}
57  
58  	/***
59  	 * The sector test.
60  	 * 
61  	 * @return The sector test.
62  	 */
63  	public Test getTest() {
64  		return this.configuration.getTest();
65  	}
66  
67  	/***
68  	 * Return the cards in this sector.
69  	 * 
70  	 * @return the cards in this sector.
71  	 */
72  	public List<AbstractCard> getCards() {
73  		return cards;
74  	}
75  
76  	/***
77  	 * Add a card to the end of list.
78  	 * 
79  	 * @param card
80  	 *          the card to add.
81  	 */
82  	public void add(MCard card) {
83  		cards.add(card);
84  	}
85  
86  	/***
87  	 * Remove the card from the list.
88  	 * 
89  	 * @param card
90  	 *          the card to remove.
91  	 * @return <tt>true</tt> if this list contained the specified element
92  	 */
93  	public boolean remove(AbstractCard card) {
94  		return cards.remove(card);
95  	}
96  
97  }