src/main/java/org/xerial/silk/cui/SilkCommand.java

   1 /*--------------------------------------------------------------------------\r
   2  *  Copyright 2009 Taro L. Saito\r
   3  *\r
   4  *  Licensed under the Apache License, Version 2.0 (the "License");\r
   5  *  you may not use this file except in compliance with the License.\r
   6  *  You may obtain a copy of the License at\r
   7  *\r
   8  *     http://www.apache.org/licenses/LICENSE-2.0\r
   9  *\r
  10  *  Unless required by applicable law or agreed to in writing, software\r
  11  *  distributed under the License is distributed on an "AS IS" BASIS,\r
  12  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  13  *  See the License for the specific language governing permissions and\r
  14  *  limitations under the License.\r
  15  *--------------------------------------------------------------------------*/\r
  16 //--------------------------------------\r
  17 // XerialJ\r
  18 //\r
  19 // SilkCommand.java\r
  20 // Since: Apr 23, 2009 6:00:29 PM\r
  21 //\r
  22 // $URL: http://www.xerial.org/svn/project/XerialJ/trunk/xerial-core/src/main/java/org/xerial/silk/cui/SilkCommand.java $\r
  23 // $Author: leo $\r
  24 //--------------------------------------\r
  25 package org.xerial.silk.cui;\r
  26 \r
  27 /**\r
  28  * Common interface for Silk CUI commands\r
  29  * \r
  30  * @author leo\r
  31  * \r
  32  */\r
  33 public interface SilkCommand\r
  34 {\r
  35 \r
  36     /**\r
  37      * Execute the command. Command line arguments are processed before the\r
  38      * invocation of this method.\r
  39      * \r
  40      * @throws Exception\r
  41      */\r
  42     public void execute() throws Exception;\r
  43 \r
  44     /**\r
  45      * command name\r
  46      * \r
  47      * @return command name\r
  48      */\r
  49     public String getName();\r
  50 \r
  51     /**\r
  52      * one-line description of the command\r
  53      * \r
  54      * @return one-line description of the command\r
  55      */\r
  56     public String getOneLineDescription();\r
  57 \r
  58 }\r