X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=website%2Ffull_javadoc%2Fcompbio%2Fmetadata%2FOption.html;h=c4885429c5451bed2a722d415811032aa6275df4;hb=f1bdd8da517901fe1d7957d388ea579ad1fbaa3b;hp=1bb99d927374b53d9f276ff7a5f532b13dd91735;hpb=535359a3d592ee41bda72e7356f0181f6cee9d07;p=jabaws.git diff --git a/website/full_javadoc/compbio/metadata/Option.html b/website/full_javadoc/compbio/metadata/Option.html index 1bb99d9..c488542 100644 --- a/website/full_javadoc/compbio/metadata/Option.html +++ b/website/full_javadoc/compbio/metadata/Option.html @@ -2,12 +2,12 @@ - + Option - + @@ -92,7 +92,7 @@ compbio.metadata
Class Option<T>
-java.lang.Object
+java.lang.Object
   extended by compbio.metadata.Option<T>
 
@@ -105,7 +105,7 @@ java.lang.Object

-
public class Option<T>
extends java.lang.Object
implements Argument<T>
+
public class Option<T>
extends Object
implements Argument<T>

@@ -115,10 +115,10 @@ Command line option/flag or multiple exclusive options with no value. Example

+
Version:
+
1.0 October 2009
Author:
-
pvtroshin - - Date October 2009
+
pvtroshin

@@ -133,8 +133,8 @@ Command line option/flag or multiple exclusive options with no value. Example Constructor Summary -Option(java.lang.String name, - java.lang.String description) +Option(String name, + String description)
            @@ -151,8 +151,8 @@ Command line option/flag or multiple exclusive options with no value. Example - java.util.Set<java.lang.String> -addOptionNames(java.lang.String... value) + Set<String> +addOptionNames(String... value)
          Adds an option to the optionName list @@ -160,14 +160,14 @@ Command line option/flag or multiple exclusive options with no value. Example  boolean -equals(java.lang.Object obj) +equals(Object obj)
            - java.lang.String + String getDefaultValue()
@@ -175,7 +175,7 @@ Command line option/flag or multiple exclusive options with no value. Example - java.lang.String + String getDescription()
@@ -183,7 +183,7 @@ Command line option/flag or multiple exclusive options with no value. Example - java.net.URL + URL getFurtherDetails()
@@ -191,7 +191,7 @@ Command line option/flag or multiple exclusive options with no value. Example - java.lang.String + String getName()
@@ -199,7 +199,7 @@ Command line option/flag or multiple exclusive options with no value. Example - java.util.List<java.lang.String> + List<String> getOptionNames()
@@ -207,7 +207,7 @@ Command line option/flag or multiple exclusive options with no value. Example - java.util.List<java.lang.String> + List<String> getPossibleValues()
@@ -233,7 +233,7 @@ Command line option/flag or multiple exclusive options with no value. Example  void -setDefaultValue(java.lang.String defaultVal) +setDefaultValue(String defaultVal)
          Sets one of the values defined in optionList as default. @@ -241,7 +241,7 @@ Command line option/flag or multiple exclusive options with no value. Example  void -setDescription(java.lang.String description) +setDescription(String description)
            @@ -249,7 +249,7 @@ Command line option/flag or multiple exclusive options with no value. Example  void -setFurtherDetails(java.net.URL furtherDetails) +setFurtherDetails(URL furtherDetails)
            @@ -257,7 +257,7 @@ Command line option/flag or multiple exclusive options with no value. Example  void -setName(java.lang.String name) +setName(String name)
            @@ -265,7 +265,7 @@ Command line option/flag or multiple exclusive options with no value. Example  void -setOptionNames(java.util.Set<java.lang.String> optionNames) +setOptionNames(Set<String> optionNames)
            @@ -281,22 +281,22 @@ Command line option/flag or multiple exclusive options with no value. Example  void -setValue(java.lang.String dValue) +setValue(String dValue)
          Set default values for the parameter or an option - java.lang.String -toCommand(java.lang.String nameValueSeparator) + String +toCommand(String nameValueSeparator)
          Convert the option to the command string. - java.lang.String + String toString()
@@ -306,10 +306,10 @@ Command line option/flag or multiple exclusive options with no value. Example   - + - +
Methods inherited from class java.lang.ObjectMethods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, waitgetClass, notify, notifyAll, wait, wait, wait
  @@ -328,8 +328,8 @@ Command line option/flag or multiple exclusive options with no value. Example

Option

-public Option(java.lang.String name,
-              java.lang.String description)
+public Option(String name, + String description)
@@ -346,7 +346,7 @@ public Option(java.lang.String name,

getName

-public java.lang.String getName()
+public String getName()
Human readable name of the option

@@ -362,7 +362,7 @@ public java.lang.String getName()

setName

-public void setName(java.lang.String name)
+public void setName(String name)
@@ -376,7 +376,7 @@ public void setName(java.lang.String name)

getDescription

-public java.lang.String getDescription()
+public String getDescription()
A long description of the Option

@@ -392,7 +392,7 @@ public java.lang.String getDescription()

setDescription

-public void setDescription(java.lang.String description)
+public void setDescription(String description)
@@ -406,7 +406,7 @@ public void setDescription(java.lang.String description)

getFurtherDetails

-public java.net.URL getFurtherDetails()
+public URL getFurtherDetails()
The URL where further details about the option can be found

@@ -422,7 +422,7 @@ public java.net.URL getFurtherDetails()

setFurtherDetails

-public void setFurtherDetails(java.net.URL furtherDetails)
+public void setFurtherDetails(URL furtherDetails)
@@ -436,7 +436,7 @@ public void setFurtherDetails(java.net.URL furtherDetails)

getDefaultValue

-public java.lang.String getDefaultValue()
+public String getDefaultValue()
A default value of the option. Defaults to command line argument name e.g. -auto @@ -453,7 +453,7 @@ public java.lang.String getDefaultValue()

setDefaultValue

-public void setDefaultValue(java.lang.String defaultVal)
+public void setDefaultValue(String defaultVal)
                      throws WrongParameterException
Sets one of the values defined in optionList as default. Attempting set @@ -505,7 +505,7 @@ public void setRequired(boolean isRequired)

getOptionNames

-public java.util.List<java.lang.String> getOptionNames()
+public List<String> getOptionNames()
@@ -520,7 +520,7 @@ public java.util.List<java.lang.String> getOptionNames()

setOptionNames

-public void setOptionNames(java.util.Set<java.lang.String> optionNames)
+public void setOptionNames(Set<String> optionNames)
@@ -534,7 +534,7 @@ public void setOptionNames(java.util.Set<java.lang.String> opt

addOptionNames

-public java.util.Set<java.lang.String> addOptionNames(java.lang.String... value)
+public Set<String> addOptionNames(String... value)
Adds an option to the optionName list

@@ -551,10 +551,10 @@ public java.util.Set<java.lang.String> addOptionNames(java.lang.Str

toString

-public java.lang.String toString()
+public String toString()
-
Overrides:
toString in class java.lang.Object
+
Overrides:
toString in class Object
@@ -565,7 +565,7 @@ public java.lang.String toString()

toCommand

-public java.lang.String toCommand(java.lang.String nameValueSeparator)
+public String toCommand(String nameValueSeparator)
Convert the option to the command string.

@@ -585,10 +585,10 @@ public java.lang.String toCommand(java.lang.String nameValueSeparato

equals

-public boolean equals(java.lang.Object obj)
+public boolean equals(Object obj)
-
Overrides:
equals in class java.lang.Object
+
Overrides:
equals in class Object
@@ -602,7 +602,7 @@ hashCode public int hashCode()
-
Overrides:
hashCode in class java.lang.Object
+
Overrides:
hashCode in class Object
@@ -613,7 +613,7 @@ public int hashCode()

getPossibleValues

-public java.util.List<java.lang.String> getPossibleValues()
+public List<String> getPossibleValues()
List of possible optionNames

@@ -630,7 +630,7 @@ public java.util.List<java.lang.String> getPossibleValues()

setValue

-public void setValue(java.lang.String dValue)
+public void setValue(String dValue)
               throws WrongParameterException
Description copied from interface: Argument