1 /*
2 OptionExecution.java
3 Creation date : 9/06/2010
4 Copyright © Benjamin Croizet (graffity2199@yahoo.fr)
5
6 This program is free software; you can redistribute it and/or
7 modify it under the terms of the GNU General Public License
8 or GNU Lesser General Public License as published by the
9 Free Software Foundation; either version 3 of the License,
10 or (at your option) any later version.
11
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
16
17 You should have received copies of the GNU General Public License
18 and GNU Lesser General Public License along with this program;
19 if not, write to the Free Software Foundation, Inc.,
20 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21 http://www.fsf.org/licensing/licenses/gpl.html
22 http://www.gnu.org/licenses/lgpl.html
23 */
24
25 package net.sourceforge.plantumldependency.commoncli.option.execution;
26
27 import java.io.Serializable;
28
29 import net.sourceforge.plantumldependency.common.clone.DeepCloneable;
30 import net.sourceforge.plantumldependency.commoncli.exception.CommandLineException;
31
32 /**
33 * The interface which describes an option execution, i.e. which executes the option.
34 *
35 * @author Benjamin Croizet (<a href="mailto:graffity2199@yahoo.fr>graffity2199@yahoo.fr</a>)
36 * @since 1.3.0
37 * @version 1.3.0
38 */
39 public interface OptionExecution extends Comparable < OptionExecution >, Serializable, DeepCloneable < OptionExecution > {
40
41 /**
42 * Executes the option.
43 *
44 * @throws CommandLineException
45 * if any exception occurs during the execution.
46 * @since 1.3.0
47 */
48 void execute() throws CommandLineException;
49
50 /**
51 * Gets the option execution priority, which is used to order the executions.
52 *
53 * @return the option priority as an integer.
54 * @since 1.3.0
55 */
56 int getPriority();
57 }