src/jalview/ws/params/OptionI.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package jalview.ws.params;
  22
  23 import java.net.URL;
  24 import java.util.List;
  25
  26 public interface OptionI extends ArgumentI
  27 {
  28   /**
  29    * Answers a URL with further details for this option, or null if none is
  30    * known
  31    *
  32    * @return
  33    */
  34   URL getFurtherDetails();
  35
  36   /**
  37    * Answers true if the option is mandatory (a value must be chosen), false if
  38    * it is optional
  39    *
  40    * @return
  41    */
  42   boolean isRequired();
  43
  44   /**
  45    * Answers the description of the option
  46    *
  47    * @return
  48    */
  49   String getDescription();
  50
  51   /**
  52    * Answers a list of possible values that may be chosen for the option (or
  53    * null if not applicable)
  54    *
  55    * @return
  56    */
  57   List<String> getPossibleValues();
  58
  59   /**
  60    * Answers a list of display names corresponding to the possible values that
  61    * may be chosen for the option (or null if not applicable)
  62    *
  63    * @return
  64    */
  65   List<String> getDisplayNames();
  66
  67   /**
  68    * Answers a new Option with a copy of the settings of this one
  69    *
  70    * @return
  71    */
  72   OptionI copy();
  73 }