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.chart;
20
21 import java.util.List;
22
23 /***
24 * @author <a href="mailto:fabdouglas@users.sourceforge.net">Fabrice Daugan </a>
25 * @since 0.93
26 */
27 public interface IChartKey extends Comparable<IChartKey> {
28
29 String toString();
30
31 /***
32 * Return the integer key.
33 *
34 * @return the integer key.
35 */
36 int getIntegerKey();
37
38 /***
39 * @return the default value of this key type.
40 */
41 IChartKey getDefault();
42
43 /***
44 * Add this key to the specified list.
45 *
46 * @param workingKeys
47 * the current key list.
48 */
49 void processAdd(List<IChartKey> workingKeys);
50 }