X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=website%2Ffull_javadoc%2Fcompbio%2Fmetadata%2FOption.html;fp=website%2Ffull_javadoc%2Fcompbio%2Fmetadata%2FOption.html;h=c4885429c5451bed2a722d415811032aa6275df4;hb=da8c820a7fb2edecb190589f3dc9c362e57a2f24;hp=0000000000000000000000000000000000000000;hpb=0bbebf27d045b1345bc042bdf24ef2e6808df251;p=jabaws.git diff --git a/website/full_javadoc/compbio/metadata/Option.html b/website/full_javadoc/compbio/metadata/Option.html new file mode 100644 index 0000000..c488542 --- /dev/null +++ b/website/full_javadoc/compbio/metadata/Option.html @@ -0,0 +1,714 @@ + + + +
+ +
+
+
|
++ + | +|||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +|||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+java.lang.Object + compbio.metadata.Option<T> ++
T
- type of executablepublic class Option<T>
+Command line option/flag or multiple exclusive options with no value. Example + -protein, -dna, -auto +
+ +
+
+Constructor Summary | +|
---|---|
Option(String name,
+ String description)
+
++ |
+
+Method Summary | +|
---|---|
+ Set<String> |
+addOptionNames(String... value)
+
++ Adds an option to the optionName list |
+
+ boolean |
+equals(Object obj)
+
++ |
+
+ String |
+getDefaultValue()
+
++ A default value of the option. |
+
+ String |
+getDescription()
+
++ A long description of the Option |
+
+ URL |
+getFurtherDetails()
+
++ The URL where further details about the option can be found |
+
+ String |
+getName()
+
++ Human readable name of the option |
+
+ List<String> |
+getOptionNames()
+
++ |
+
+ List<String> |
+getPossibleValues()
+
++ List of possible optionNames |
+
+ int |
+hashCode()
+
++ |
+
+ boolean |
+isRequired()
+
++ Flag that indicated that this option must be specified in the command + line for an executable to run |
+
+ void |
+setDefaultValue(String defaultVal)
+
++ Sets one of the values defined in optionList as default. |
+
+ void |
+setDescription(String description)
+
++ |
+
+ void |
+setFurtherDetails(URL furtherDetails)
+
++ |
+
+ void |
+setName(String name)
+
++ |
+
+ void |
+setOptionNames(Set<String> optionNames)
+
++ |
+
+ void |
+setRequired(boolean isRequired)
+
++ |
+
+ void |
+setValue(String dValue)
+
++ Set default values for the parameter or an option |
+
+ String |
+toCommand(String nameValueSeparator)
+
++ Convert the option to the command string. |
+
+ String |
+toString()
+
++ |
+
Methods inherited from class java.lang.Object | +
---|
getClass, notify, notifyAll, wait, wait, wait |
+
+Constructor Detail | +
---|
+public Option(String name, + String description)+
+Method Detail | +
---|
+public String getName()+
+
getName
in interface Argument<T>
+public void setName(String name)+
+public String getDescription()+
+
getDescription
in interface Argument<T>
+public void setDescription(String description)+
+public URL getFurtherDetails()+
+
getFurtherDetails
in interface Argument<T>
+public void setFurtherDetails(URL furtherDetails)+
+public String getDefaultValue()+
+
getDefaultValue
in interface Argument<T>
+public void setDefaultValue(String defaultVal) + throws WrongParameterException+
+
defaultVal
-
+WrongParameterException
- is thrown if the defaultValue is not found in optionList+public boolean isRequired()+
+
+public void setRequired(boolean isRequired)+
+public List<String> getOptionNames()+
+public void setOptionNames(Set<String> optionNames)+
+public Set<String> addOptionNames(String... value)+
+
value
-
++public String toString()+
toString
in class Object
+public String toCommand(String nameValueSeparator)+
+
+public boolean equals(Object obj)+
equals
in class Object
+public int hashCode()+
hashCode
in class Object
+public List<String> getPossibleValues()+
+
getPossibleValues
in interface Argument<T>
+public void setValue(String dValue) + throws WrongParameterException+
Argument
+
setValue
in interface Argument<T>
dValue
- the value to be set
+WrongParameterException
- - when the value to be set is illegal. Wrong value for
+ numeric parameter is the value defined outside it , for
+ string type parameter, wrong value is the one which is not
+ listed in possible values listValueConstrain
+
+
|
++ + | +|||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +|||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +