|
||||||||||
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(java.lang.String name,
java.lang.String description)
|
Method Summary | |
---|---|
java.util.Set<java.lang.String> |
addOptionNames(java.lang.String... value)
Adds an option to the optionName list |
boolean |
equals(java.lang.Object obj)
|
java.lang.String |
getDefaultValue()
A default value of the option. |
java.lang.String |
getDescription()
A long description of the Option |
java.net.URL |
getFurtherDetails()
The URL where further details about the option can be found |
java.lang.String |
getName()
Human readable name of the option |
java.util.List<java.lang.String> |
getOptionNames()
|
java.util.List<java.lang.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(java.lang.String defaultVal)
Sets one of the values defined in optionList as default. |
void |
setDescription(java.lang.String description)
|
void |
setFurtherDetails(java.net.URL furtherDetails)
|
void |
setName(java.lang.String name)
|
void |
setOptionNames(java.util.Set<java.lang.String> optionNames)
|
void |
setRequired(boolean isRequired)
|
void |
setValue(java.lang.String dValue)
Set default values for the parameter or an option |
java.lang.String |
toCommand(java.lang.String nameValueSeparator)
Convert the option to the command string. |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public Option(java.lang.String name, java.lang.String description)
Method Detail |
---|
public java.lang.String getName()
getName
in interface Argument<T>
public void setName(java.lang.String name)
public java.lang.String getDescription()
getDescription
in interface Argument<T>
public void setDescription(java.lang.String description)
public java.net.URL getFurtherDetails()
getFurtherDetails
in interface Argument<T>
public void setFurtherDetails(java.net.URL furtherDetails)
public java.lang.String getDefaultValue()
getDefaultValue
in interface Argument<T>
public void setDefaultValue(java.lang.String defaultVal) throws WrongParameterException
defaultVal
-
WrongParameterException
- is thrown if the defaultValue is not found in optionListpublic boolean isRequired()
public void setRequired(boolean isRequired)
public java.util.List<java.lang.String> getOptionNames()
public void setOptionNames(java.util.Set<java.lang.String> optionNames)
public java.util.Set<java.lang.String> addOptionNames(java.lang.String... value)
value
-
public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String toCommand(java.lang.String nameValueSeparator)
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public java.util.List<java.lang.String> getPossibleValues()
getPossibleValues
in interface Argument<T>
public void setValue(java.lang.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 |