01: /*
02: * This program is free software; you can redistribute it and/or modify
03: * it under the terms of the GNU General Public License as published by
04: * the Free Software Foundation; either version 2 of the License, or
05: * (at your option) any later version.
06: *
07: * This program is distributed in the hope that it will be useful,
08: * but WITHOUT ANY WARRANTY; without even the implied warranty of
09: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10: * GNU General Public License for more details.
11: *
12: * You should have received a copy of the GNU General Public License
13: * along with this program; if not, write to the Free Software
14: * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
15: */
16:
17: /*
18: * OptionHandler.java
19: * Copyright (C) 1999 University of Waikato, Hamilton, New Zealand
20: *
21: */
22:
23: package weka.core;
24:
25: import java.util.*;
26:
27: /**
28: * Interface to something that understands options.
29: *
30: * @author Eibe Frank (eibe@cs.waikato.ac.nz)
31: * @author Len Trigg (trigg@cs.waikato.ac.nz)
32: * @version $Revision: 1.8 $
33: */
34: public interface OptionHandler {
35:
36: /**
37: * Returns an enumeration of all the available options..
38: *
39: * @return an enumeration of all available options.
40: */
41: Enumeration listOptions();
42:
43: /**
44: * Sets the OptionHandler's options using the given list. All options
45: * will be set (or reset) during this call (i.e. incremental setting
46: * of options is not possible).
47: *
48: * @param options the list of options as an array of strings
49: * @exception Exception if an option is not supported
50: */
51: //@ requires options != null;
52: //@ requires \nonnullelements(options);
53: void setOptions(String[] options) throws Exception;
54:
55: /**
56: * Gets the current option settings for the OptionHandler.
57: *
58: * @return the list of current option settings as an array of strings
59: */
60: //@ ensures \result != null;
61: //@ ensures \nonnullelements(\result);
62: /*@pure@*/String[] getOptions();
63: }
|