X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fws%2Fparams%2FOptionI.java;h=af8ae27dec97fa872f5a5ea6e73b09084bd1e95e;hb=c41398473f1493a06f28da53be50630a0f6e6f6d;hp=b87d775c4d6b02d681f09943c4e7fef716b13d07;hpb=ab43013b7e357b84b4abade0dba949668dfb2a0e;p=jalview.git diff --git a/src/jalview/ws/params/OptionI.java b/src/jalview/ws/params/OptionI.java index b87d775..af8ae27 100644 --- a/src/jalview/ws/params/OptionI.java +++ b/src/jalview/ws/params/OptionI.java @@ -1,6 +1,6 @@ /* - * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2b1) - * Copyright (C) 2014 The Jalview Authors + * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$) + * Copyright (C) $$Year-Rel$$ The Jalview Authors * * This file is part of Jalview. * @@ -25,15 +25,49 @@ import java.util.List; public interface OptionI extends ArgumentI { - + /** + * Answers a URL with further details for this option, or null if none is + * known + * + * @return + */ URL getFurtherDetails(); + /** + * Answers true if the option is mandatory (a value must be chosen), false if + * it is optional + * + * @return + */ boolean isRequired(); + /** + * Answers the description of the option + * + * @return + */ String getDescription(); + /** + * Answers a list of possible values that may be chosen for the option (or + * null if not applicable) + * + * @return + */ List getPossibleValues(); - OptionI copy(); + /** + * Answers a list of display names corresponding to the possible values that + * may be chosen for the option (or null if not applicable) + * + * @return + */ + List getDisplayNames(); + /** + * Answers a new Option with a copy of the settings of this one + * + * @return + */ + OptionI copy(); }