1 /***
2 * EnumerationInitializer.java
3 *
4 * This file is part of the creme library.
5 * The creme library intends to ease the development effort of large
6 * applications by providing easy to use support classes.
7 *
8 * Copyright (C) 2002 Denis Bregeon
9 *
10 * This library is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU Lesser General Public
12 * License as published by the Free Software Foundation; either
13 * version 2.1 of the License, or (at your option) any later version.
14 *
15 * This library is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 * Lesser General Public License for more details.
19 *
20 * You should have received a copy of the GNU Lesser General Public
21 * License along with this library; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23 *
24 * contact information: dbregeon@sourceforge.net
25 */
26 package org.jcreme.enumerations;
27
28 /***
29 * This interface specifies what an EnumerationIntializer must be. These
30 * initializers must be used to import the values of various Enumeration
31 * subclasses. It is up to the application developper to determine which classes
32 * must have their values loaded.
33 *
34 * @author $Author: dbregeon $
35 * @version $Revision: 1.1 $
36 */
37 public interface EnumerationInitializer {
38 /***
39 * This method enables to load the values associated with the given class.
40 * After a call to this method, the values are available through the usual
41 * class methods.
42 *
43 * @param enumerationClass
44 * a subclass of the Enumeration Class.
45 * @throws IllegalArgumentException
46 * if the given class is null, not a subclass of Enumeration or
47 * an abstract sublass of Enumeration.
48 */
49 public void loadValues(Class enumerationClass)
50 throws IllegalArgumentException;
51 }