1 /*--------------------------------------------------------------------------
2 * Copyright 2008 utgenome.org
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 *--------------------------------------------------------------------------*/
16 //--------------------------------------
17 // utgb-shell Project
18 //
19 // UTGBShellSubCommand.java
20 // Since: Jan 9, 2008
21 //
22 // $URL: http://svn.utgenome.org/utgb/trunk/utgb/utgb-shell/src/main/java/org/utgenome/shell/UTGBShellSubCommand.java $
23 // $Author: leo $
24 //--------------------------------------
25 package org.utgenome.shell;
26
27 import org.utgenome.shell.UTGBShell.UTGBShellOption;
28
29 /**
30 * A common interface of UTGB Shell subcommands
31 *
32 * @author leo
33 *
34 */
35 public interface UTGBShellSubCommand extends Comparable<UTGBShellSubCommand> {
36
37 public String name();
38
39 public String getOneLinerDescription();
40
41 public String getDetailedDescription();
42
43 public String getOptionList();
44
45 public void execute(UTGBShellOption globalOption, String[] args) throws UTGBShellException;
46
47 public void execute(String[] args) throws UTGBShellException;
48
49 }