website/dm_javadoc/compbio/metadata/Option.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">\r
   2 <!--NewPage-->\r
   3 <HTML>\r
   4 <HEAD>\r
   5 <!-- Generated by javadoc (build 1.6.0_21) on Wed Nov 24 12:17:18 GMT 2010 -->\r
   6 <TITLE>\r
   7 Option\r
   8 </TITLE>\r
   9 \r
  10 <META NAME="date" CONTENT="2010-11-24">\r
  11 \r
  12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">\r
  13 \r
  14 <SCRIPT type="text/javascript">\r
  15 function windowTitle()\r
  16 {\r
  17     if (location.href.indexOf('is-external=true') == -1) {\r
  18         parent.document.title="Option";\r
  19     }\r
  20 }\r
  21 </SCRIPT>\r
  22 <NOSCRIPT>\r
  23 </NOSCRIPT>\r
  24 \r
  25 </HEAD>\r
  26 \r
  27 <BODY BGCOLOR="white" onload="windowTitle();">\r
  28 <HR>\r
  29 \r
  30 \r
  31 <!-- ========= START OF TOP NAVBAR ======= -->\r
  32 <A NAME="navbar_top"><!-- --></A>\r
  33 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>\r
  34 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
  35 <TR>\r
  36 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
  37 <A NAME="navbar_top_firstrow"><!-- --></A>\r
  38 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
  39   <TR ALIGN="center" VALIGN="top">\r
  40   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
  41   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
  42   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
  43   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Option.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
  44   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
  45   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
  46   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
  47   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
  48   </TR>\r
  49 </TABLE>\r
  50 </TD>\r
  51 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
  52 </EM>\r
  53 </TD>\r
  54 </TR>\r
  55 \r
  56 <TR>\r
  57 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
  58 &nbsp;<A HREF="../../compbio/metadata/LimitsManager.html" title="class in compbio.metadata"><B>PREV CLASS</B></A>&nbsp;\r
  59 &nbsp;<A HREF="../../compbio/metadata/Parameter.html" title="class in compbio.metadata"><B>NEXT CLASS</B></A></FONT></TD>\r
  60 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
  61   <A HREF="../../index.html?compbio/metadata/Option.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
  62 &nbsp;<A HREF="Option.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
  63 &nbsp;<SCRIPT type="text/javascript">\r
  64   <!--\r
  65   if(window==top) {\r
  66     document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');\r
  67   }\r
  68   //-->\r
  69 </SCRIPT>\r
  70 <NOSCRIPT>\r
  71   <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>\r
  72 </NOSCRIPT>\r
  73 \r
  74 \r
  75 </FONT></TD>\r
  76 </TR>\r
  77 <TR>\r
  78 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
  79   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
  80 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
  81 DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
  82 </TR>\r
  83 </TABLE>\r
  84 <A NAME="skip-navbar_top"></A>\r
  85 <!-- ========= END OF TOP NAVBAR ========= -->\r
  86 \r
  87 <HR>\r
  88 <!-- ======== START OF CLASS DATA ======== -->\r
  89 <H2>\r
  90 <FONT SIZE="-1">\r
  91 compbio.metadata</FONT>\r
  92 <BR>\r
  93 Class Option&lt;T&gt;</H2>\r
  94 <PRE>\r
  95 <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>\r
  96   <IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>compbio.metadata.Option&lt;T&gt;</B>\r
  97 </PRE>\r
  98 <DL>\r
  99 <DT><DT><B>Type Parameters:</B><DD><CODE>T</CODE> - type of executable</DL>\r
 100 <DL>\r
 101 <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../compbio/metadata/Argument.html" title="interface in compbio.metadata">Argument</A>&lt;T&gt;</DD>\r
 102 </DL>\r
 103 <DL>\r
 104 <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../compbio/metadata/Parameter.html" title="class in compbio.metadata">Parameter</A></DD>\r
 105 </DL>\r
 106 <HR>\r
 107 <DL>\r
 108 <DT><PRE>public class <B>Option&lt;T&gt;</B><DT>extends <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A><DT>implements <A HREF="../../compbio/metadata/Argument.html" title="interface in compbio.metadata">Argument</A>&lt;T&gt;</DL>\r
 109 </PRE>\r
 110 \r
 111 <P>\r
 112 Command line option/flag or multiple exclusive options with no value. Example
 113  -protein, -dna, -auto\r
 114 <P>\r
 115 \r
 116 <P>\r
 117 <DL>\r
 118 <DT><B>Version:</B></DT>\r
 119   <DD>1.0 October 2009</DD>\r
 120 <DT><B>Author:</B></DT>\r
 121   <DD>pvtroshin</DD>\r
 122 </DL>\r
 123 <HR>\r
 124 \r
 125 <P>\r
 126 <!-- =========== FIELD SUMMARY =========== -->\r
 127 \r
 128 <A NAME="field_summary"><!-- --></A>\r
 129 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 130 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 131 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
 132 <B>Field Summary</B></FONT></TH>\r
 133 </TR>\r
 134 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 135 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 136 <CODE>protected &nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>\r
 137 <TD><CODE><B><A HREF="../../compbio/metadata/Option.html#defaultValue">defaultValue</A></B></CODE>\r
 138 \r
 139 <BR>\r
 140 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
 141 </TR>\r
 142 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 143 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 144 <CODE>protected &nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>\r
 145 <TD><CODE><B><A HREF="../../compbio/metadata/Option.html#description">description</A></B></CODE>\r
 146 \r
 147 <BR>\r
 148 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
 149 </TR>\r
 150 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 151 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 152 <CODE>protected &nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net">URL</A></CODE></FONT></TD>\r
 153 <TD><CODE><B><A HREF="../../compbio/metadata/Option.html#furtherDetails">furtherDetails</A></B></CODE>\r
 154 \r
 155 <BR>\r
 156 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
 157 </TR>\r
 158 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 159 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 160 <CODE>protected &nbsp;boolean</CODE></FONT></TD>\r
 161 <TD><CODE><B><A HREF="../../compbio/metadata/Option.html#isRequired">isRequired</A></B></CODE>\r
 162 \r
 163 <BR>\r
 164 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
 165 </TR>\r
 166 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 167 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 168 <CODE>protected &nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>\r
 169 <TD><CODE><B><A HREF="../../compbio/metadata/Option.html#name">name</A></B></CODE>\r
 170 \r
 171 <BR>\r
 172 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
 173 </TR>\r
 174 </TABLE>\r
 175 &nbsp;\r
 176 <!-- ======== CONSTRUCTOR SUMMARY ======== -->\r
 177 \r
 178 <A NAME="constructor_summary"><!-- --></A>\r
 179 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 180 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 181 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
 182 <B>Constructor Summary</B></FONT></TH>\r
 183 </TR>\r
 184 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 185 <TD><CODE><B><A HREF="../../compbio/metadata/Option.html#Option(java.lang.String, java.lang.String)">Option</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;name,\r
 186        <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;description)</CODE>\r
 187 \r
 188 <BR>\r
 189 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
 190 </TR>\r
 191 </TABLE>\r
 192 &nbsp;\r
 193 <!-- ========== METHOD SUMMARY =========== -->\r
 194 \r
 195 <A NAME="method_summary"><!-- --></A>\r
 196 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 197 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 198 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
 199 <B>Method Summary</B></FONT></TH>\r
 200 </TR>\r
 201 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 202 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 203 <CODE>&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</A>&lt;<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&gt;</CODE></FONT></TD>\r
 204 <TD><CODE><B><A HREF="../../compbio/metadata/Option.html#addOptionNames(java.lang.String...)">addOptionNames</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>...&nbsp;value)</CODE>\r
 205 \r
 206 <BR>\r
 207 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds an option to the optionName list</TD>\r
 208 </TR>\r
 209 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 210 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 211 <CODE>&nbsp;boolean</CODE></FONT></TD>\r
 212 <TD><CODE><B><A HREF="../../compbio/metadata/Option.html#equals(java.lang.Object)">equals</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>&nbsp;obj)</CODE>\r
 213 \r
 214 <BR>\r
 215 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
 216 </TR>\r
 217 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 218 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 219 <CODE>&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>\r
 220 <TD><CODE><B><A HREF="../../compbio/metadata/Option.html#getDefaultValue()">getDefaultValue</A></B>()</CODE>\r
 221 \r
 222 <BR>\r
 223 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A default value of the option.</TD>\r
 224 </TR>\r
 225 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 226 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 227 <CODE>&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>\r
 228 <TD><CODE><B><A HREF="../../compbio/metadata/Option.html#getDescription()">getDescription</A></B>()</CODE>\r
 229 \r
 230 <BR>\r
 231 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A long description of the Option</TD>\r
 232 </TR>\r
 233 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 234 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 235 <CODE>&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net">URL</A></CODE></FONT></TD>\r
 236 <TD><CODE><B><A HREF="../../compbio/metadata/Option.html#getFurtherDetails()">getFurtherDetails</A></B>()</CODE>\r
 237 \r
 238 <BR>\r
 239 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The URL where further details about the option can be found</TD>\r
 240 </TR>\r
 241 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 242 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 243 <CODE>&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>\r
 244 <TD><CODE><B><A HREF="../../compbio/metadata/Option.html#getName()">getName</A></B>()</CODE>\r
 245 \r
 246 <BR>\r
 247 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Human readable name of the option</TD>\r
 248 </TR>\r
 249 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 250 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 251 <CODE>&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A>&lt;<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&gt;</CODE></FONT></TD>\r
 252 <TD><CODE><B><A HREF="../../compbio/metadata/Option.html#getOptionNames()">getOptionNames</A></B>()</CODE>\r
 253 \r
 254 <BR>\r
 255 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
 256 </TR>\r
 257 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 258 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 259 <CODE>&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A>&lt;<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&gt;</CODE></FONT></TD>\r
 260 <TD><CODE><B><A HREF="../../compbio/metadata/Option.html#getPossibleValues()">getPossibleValues</A></B>()</CODE>\r
 261 \r
 262 <BR>\r
 263 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;List of possible optionNames</TD>\r
 264 </TR>\r
 265 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 266 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 267 <CODE>&nbsp;int</CODE></FONT></TD>\r
 268 <TD><CODE><B><A HREF="../../compbio/metadata/Option.html#hashCode()">hashCode</A></B>()</CODE>\r
 269 \r
 270 <BR>\r
 271 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
 272 </TR>\r
 273 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 274 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 275 <CODE>&nbsp;boolean</CODE></FONT></TD>\r
 276 <TD><CODE><B><A HREF="../../compbio/metadata/Option.html#isRequired()">isRequired</A></B>()</CODE>\r
 277 \r
 278 <BR>\r
 279 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Flag that indicated that this option must be specified in the command
 280  line for an executable to run</TD>\r
 281 </TR>\r
 282 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 283 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 284 <CODE>&nbsp;void</CODE></FONT></TD>\r
 285 <TD><CODE><B><A HREF="../../compbio/metadata/Option.html#setDefaultValue(java.lang.String)">setDefaultValue</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;defaultVal)</CODE>\r
 286 \r
 287 <BR>\r
 288 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets one of the values defined in optionList as default.</TD>\r
 289 </TR>\r
 290 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 291 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 292 <CODE>&nbsp;void</CODE></FONT></TD>\r
 293 <TD><CODE><B><A HREF="../../compbio/metadata/Option.html#setDescription(java.lang.String)">setDescription</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;description)</CODE>\r
 294 \r
 295 <BR>\r
 296 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
 297 </TR>\r
 298 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 299 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 300 <CODE>&nbsp;void</CODE></FONT></TD>\r
 301 <TD><CODE><B><A HREF="../../compbio/metadata/Option.html#setFurtherDetails(java.net.URL)">setFurtherDetails</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net">URL</A>&nbsp;furtherDetails)</CODE>\r
 302 \r
 303 <BR>\r
 304 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
 305 </TR>\r
 306 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 307 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 308 <CODE>&nbsp;void</CODE></FONT></TD>\r
 309 <TD><CODE><B><A HREF="../../compbio/metadata/Option.html#setName(java.lang.String)">setName</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;name)</CODE>\r
 310 \r
 311 <BR>\r
 312 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
 313 </TR>\r
 314 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 315 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 316 <CODE>&nbsp;void</CODE></FONT></TD>\r
 317 <TD><CODE><B><A HREF="../../compbio/metadata/Option.html#setOptionNames(java.util.Set)">setOptionNames</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</A>&lt;<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&gt;&nbsp;optionNames)</CODE>\r
 318 \r
 319 <BR>\r
 320 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
 321 </TR>\r
 322 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 323 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 324 <CODE>&nbsp;void</CODE></FONT></TD>\r
 325 <TD><CODE><B><A HREF="../../compbio/metadata/Option.html#setRequired(boolean)">setRequired</A></B>(boolean&nbsp;isRequired)</CODE>\r
 326 \r
 327 <BR>\r
 328 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
 329 </TR>\r
 330 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 331 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 332 <CODE>&nbsp;void</CODE></FONT></TD>\r
 333 <TD><CODE><B><A HREF="../../compbio/metadata/Option.html#setValue(java.lang.String)">setValue</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;dValue)</CODE>\r
 334 \r
 335 <BR>\r
 336 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set default values for the parameter or an option</TD>\r
 337 </TR>\r
 338 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 339 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 340 <CODE>&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>\r
 341 <TD><CODE><B><A HREF="../../compbio/metadata/Option.html#toCommand(java.lang.String)">toCommand</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;nameValueSeparator)</CODE>\r
 342 \r
 343 <BR>\r
 344 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Convert the option to the command string.</TD>\r
 345 </TR>\r
 346 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 347 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 348 <CODE>&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>\r
 349 <TD><CODE><B><A HREF="../../compbio/metadata/Option.html#toString()">toString</A></B>()</CODE>\r
 350 \r
 351 <BR>\r
 352 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
 353 </TR>\r
 354 </TABLE>\r
 355 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>\r
 356 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 357 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
 358 <TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>\r
 359 </TR>\r
 360 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 361 <TD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>\r
 362 </TR>\r
 363 </TABLE>\r
 364 &nbsp;\r
 365 <P>\r
 366 \r
 367 <!-- ============ FIELD DETAIL =========== -->\r
 368 \r
 369 <A NAME="field_detail"><!-- --></A>\r
 370 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 371 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 372 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
 373 <B>Field Detail</B></FONT></TH>\r
 374 </TR>\r
 375 </TABLE>\r
 376 \r
 377 <A NAME="description"><!-- --></A><H3>\r
 378 description</H3>\r
 379 <PRE>\r
 380 protected <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>description</B></PRE>\r
 381 <DL>\r
 382 <DL>\r
 383 </DL>\r
 384 </DL>\r
 385 <HR>\r
 386 \r
 387 <A NAME="name"><!-- --></A><H3>\r
 388 name</H3>\r
 389 <PRE>\r
 390 protected <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>name</B></PRE>\r
 391 <DL>\r
 392 <DL>\r
 393 </DL>\r
 394 </DL>\r
 395 <HR>\r
 396 \r
 397 <A NAME="isRequired"><!-- --></A><H3>\r
 398 isRequired</H3>\r
 399 <PRE>\r
 400 protected boolean <B>isRequired</B></PRE>\r
 401 <DL>\r
 402 <DL>\r
 403 </DL>\r
 404 </DL>\r
 405 <HR>\r
 406 \r
 407 <A NAME="furtherDetails"><!-- --></A><H3>\r
 408 furtherDetails</H3>\r
 409 <PRE>\r
 410 protected <A HREF="http://java.sun.com/javase/6/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net">URL</A> <B>furtherDetails</B></PRE>\r
 411 <DL>\r
 412 <DL>\r
 413 </DL>\r
 414 </DL>\r
 415 <HR>\r
 416 \r
 417 <A NAME="defaultValue"><!-- --></A><H3>\r
 418 defaultValue</H3>\r
 419 <PRE>\r
 420 protected <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>defaultValue</B></PRE>\r
 421 <DL>\r
 422 <DL>\r
 423 </DL>\r
 424 </DL>\r
 425 \r
 426 <!-- ========= CONSTRUCTOR DETAIL ======== -->\r
 427 \r
 428 <A NAME="constructor_detail"><!-- --></A>\r
 429 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 430 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 431 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
 432 <B>Constructor Detail</B></FONT></TH>\r
 433 </TR>\r
 434 </TABLE>\r
 435 \r
 436 <A NAME="Option(java.lang.String, java.lang.String)"><!-- --></A><H3>\r
 437 Option</H3>\r
 438 <PRE>\r
 439 public <B>Option</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;name,\r
 440               <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;description)</PRE>\r
 441 <DL>\r
 442 </DL>\r
 443 \r
 444 <!-- ============ METHOD DETAIL ========== -->\r
 445 \r
 446 <A NAME="method_detail"><!-- --></A>\r
 447 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 448 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 449 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
 450 <B>Method Detail</B></FONT></TH>\r
 451 </TR>\r
 452 </TABLE>\r
 453 \r
 454 <A NAME="getName()"><!-- --></A><H3>\r
 455 getName</H3>\r
 456 <PRE>\r
 457 public <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getName</B>()</PRE>\r
 458 <DL>\r
 459 <DD>Human readable name of the option\r
 460 <P>\r
 461 <DD><DL>\r
 462 <DT><B>Specified by:</B><DD><CODE><A HREF="../../compbio/metadata/Argument.html#getName()">getName</A></CODE> in interface <CODE><A HREF="../../compbio/metadata/Argument.html" title="interface in compbio.metadata">Argument</A>&lt;<A HREF="../../compbio/metadata/Option.html" title="type parameter in Option">T</A>&gt;</CODE></DL>\r
 463 </DD>\r
 464 <DD><DL>\r
 465 </DL>\r
 466 </DD>\r
 467 </DL>\r
 468 <HR>\r
 469 \r
 470 <A NAME="setName(java.lang.String)"><!-- --></A><H3>\r
 471 setName</H3>\r
 472 <PRE>\r
 473 public void <B>setName</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;name)</PRE>\r
 474 <DL>\r
 475 <DD><DL>\r
 476 </DL>\r
 477 </DD>\r
 478 <DD><DL>\r
 479 </DL>\r
 480 </DD>\r
 481 </DL>\r
 482 <HR>\r
 483 \r
 484 <A NAME="getDescription()"><!-- --></A><H3>\r
 485 getDescription</H3>\r
 486 <PRE>\r
 487 public <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getDescription</B>()</PRE>\r
 488 <DL>\r
 489 <DD>A long description of the Option\r
 490 <P>\r
 491 <DD><DL>\r
 492 <DT><B>Specified by:</B><DD><CODE><A HREF="../../compbio/metadata/Argument.html#getDescription()">getDescription</A></CODE> in interface <CODE><A HREF="../../compbio/metadata/Argument.html" title="interface in compbio.metadata">Argument</A>&lt;<A HREF="../../compbio/metadata/Option.html" title="type parameter in Option">T</A>&gt;</CODE></DL>\r
 493 </DD>\r
 494 <DD><DL>\r
 495 </DL>\r
 496 </DD>\r
 497 </DL>\r
 498 <HR>\r
 499 \r
 500 <A NAME="setDescription(java.lang.String)"><!-- --></A><H3>\r
 501 setDescription</H3>\r
 502 <PRE>\r
 503 public void <B>setDescription</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;description)</PRE>\r
 504 <DL>\r
 505 <DD><DL>\r
 506 </DL>\r
 507 </DD>\r
 508 <DD><DL>\r
 509 </DL>\r
 510 </DD>\r
 511 </DL>\r
 512 <HR>\r
 513 \r
 514 <A NAME="getFurtherDetails()"><!-- --></A><H3>\r
 515 getFurtherDetails</H3>\r
 516 <PRE>\r
 517 public <A HREF="http://java.sun.com/javase/6/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net">URL</A> <B>getFurtherDetails</B>()</PRE>\r
 518 <DL>\r
 519 <DD>The URL where further details about the option can be found\r
 520 <P>\r
 521 <DD><DL>\r
 522 <DT><B>Specified by:</B><DD><CODE><A HREF="../../compbio/metadata/Argument.html#getFurtherDetails()">getFurtherDetails</A></CODE> in interface <CODE><A HREF="../../compbio/metadata/Argument.html" title="interface in compbio.metadata">Argument</A>&lt;<A HREF="../../compbio/metadata/Option.html" title="type parameter in Option">T</A>&gt;</CODE></DL>\r
 523 </DD>\r
 524 <DD><DL>\r
 525 </DL>\r
 526 </DD>\r
 527 </DL>\r
 528 <HR>\r
 529 \r
 530 <A NAME="setFurtherDetails(java.net.URL)"><!-- --></A><H3>\r
 531 setFurtherDetails</H3>\r
 532 <PRE>\r
 533 public void <B>setFurtherDetails</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net">URL</A>&nbsp;furtherDetails)</PRE>\r
 534 <DL>\r
 535 <DD><DL>\r
 536 </DL>\r
 537 </DD>\r
 538 <DD><DL>\r
 539 </DL>\r
 540 </DD>\r
 541 </DL>\r
 542 <HR>\r
 543 \r
 544 <A NAME="getDefaultValue()"><!-- --></A><H3>\r
 545 getDefaultValue</H3>\r
 546 <PRE>\r
 547 public <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getDefaultValue</B>()</PRE>\r
 548 <DL>\r
 549 <DD>A default value of the option. Defaults to command line argument name
 550  e.g. -auto\r
 551 <P>\r
 552 <DD><DL>\r
 553 <DT><B>Specified by:</B><DD><CODE><A HREF="../../compbio/metadata/Argument.html#getDefaultValue()">getDefaultValue</A></CODE> in interface <CODE><A HREF="../../compbio/metadata/Argument.html" title="interface in compbio.metadata">Argument</A>&lt;<A HREF="../../compbio/metadata/Option.html" title="type parameter in Option">T</A>&gt;</CODE></DL>\r
 554 </DD>\r
 555 <DD><DL>\r
 556 </DL>\r
 557 </DD>\r
 558 </DL>\r
 559 <HR>\r
 560 \r
 561 <A NAME="setDefaultValue(java.lang.String)"><!-- --></A><H3>\r
 562 setDefaultValue</H3>\r
 563 <PRE>\r
 564 public void <B>setDefaultValue</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;defaultVal)\r
 565                      throws <A HREF="../../compbio/metadata/WrongParameterException.html" title="class in compbio.metadata">WrongParameterException</A></PRE>\r
 566 <DL>\r
 567 <DD>Sets one of the values defined in optionList as default. Attempting set
 568  the value not listed there will result in WrongParameter exception\r
 569 <P>\r
 570 <DD><DL>\r
 571 </DL>\r
 572 </DD>\r
 573 <DD><DL>\r
 574 <DT><B>Parameters:</B><DD><CODE>defaultVal</CODE> - \r
 575 <DT><B>Throws:</B>\r
 576 <DD><CODE><A HREF="../../compbio/metadata/WrongParameterException.html" title="class in compbio.metadata">WrongParameterException</A></CODE> - is thrown if the defaultValue is not found in optionList</DL>\r
 577 </DD>\r
 578 </DL>\r
 579 <HR>\r
 580 \r
 581 <A NAME="isRequired()"><!-- --></A><H3>\r
 582 isRequired</H3>\r
 583 <PRE>\r
 584 public boolean <B>isRequired</B>()</PRE>\r
 585 <DL>\r
 586 <DD>Flag that indicated that this option must be specified in the command
 587  line for an executable to run\r
 588 <P>\r
 589 <DD><DL>\r
 590 </DL>\r
 591 </DD>\r
 592 <DD><DL>\r
 593 \r
 594 <DT><B>Returns:</B><DD>true is the option is required, false otherwise</DL>\r
 595 </DD>\r
 596 </DL>\r
 597 <HR>\r
 598 \r
 599 <A NAME="setRequired(boolean)"><!-- --></A><H3>\r
 600 setRequired</H3>\r
 601 <PRE>\r
 602 public void <B>setRequired</B>(boolean&nbsp;isRequired)</PRE>\r
 603 <DL>\r
 604 <DD><DL>\r
 605 </DL>\r
 606 </DD>\r
 607 <DD><DL>\r
 608 </DL>\r
 609 </DD>\r
 610 </DL>\r
 611 <HR>\r
 612 \r
 613 <A NAME="getOptionNames()"><!-- --></A><H3>\r
 614 getOptionNames</H3>\r
 615 <PRE>\r
 616 public <A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A>&lt;<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&gt; <B>getOptionNames</B>()</PRE>\r
 617 <DL>\r
 618 <DD><DL>\r
 619 </DL>\r
 620 </DD>\r
 621 <DD><DL>\r
 622 \r
 623 <DT><B>Returns:</B><DD>List of option names</DL>\r
 624 </DD>\r
 625 </DL>\r
 626 <HR>\r
 627 \r
 628 <A NAME="setOptionNames(java.util.Set)"><!-- --></A><H3>\r
 629 setOptionNames</H3>\r
 630 <PRE>\r
 631 public void <B>setOptionNames</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</A>&lt;<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&gt;&nbsp;optionNames)</PRE>\r
 632 <DL>\r
 633 <DD><DL>\r
 634 </DL>\r
 635 </DD>\r
 636 <DD><DL>\r
 637 </DL>\r
 638 </DD>\r
 639 </DL>\r
 640 <HR>\r
 641 \r
 642 <A NAME="addOptionNames(java.lang.String...)"><!-- --></A><H3>\r
 643 addOptionNames</H3>\r
 644 <PRE>\r
 645 public <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</A>&lt;<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&gt; <B>addOptionNames</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>...&nbsp;value)</PRE>\r
 646 <DL>\r
 647 <DD>Adds an option to the optionName list\r
 648 <P>\r
 649 <DD><DL>\r
 650 </DL>\r
 651 </DD>\r
 652 <DD><DL>\r
 653 <DT><B>Parameters:</B><DD><CODE>value</CODE> - \r
 654 <DT><B>Returns:</B><DD>modified optionName list</DL>\r
 655 </DD>\r
 656 </DL>\r
 657 <HR>\r
 658 \r
 659 <A NAME="toString()"><!-- --></A><H3>\r
 660 toString</H3>\r
 661 <PRE>\r
 662 public <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>toString</B>()</PRE>\r
 663 <DL>\r
 664 <DD><DL>\r
 665 <DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A></CODE> in class <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></DL>\r
 666 </DD>\r
 667 <DD><DL>\r
 668 </DL>\r
 669 </DD>\r
 670 </DL>\r
 671 <HR>\r
 672 \r
 673 <A NAME="toCommand(java.lang.String)"><!-- --></A><H3>\r
 674 toCommand</H3>\r
 675 <PRE>\r
 676 public <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>toCommand</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;nameValueSeparator)</PRE>\r
 677 <DL>\r
 678 <DD>Convert the option to the command string.\r
 679 <P>\r
 680 <DD><DL>\r
 681 </DL>\r
 682 </DD>\r
 683 <DD><DL>\r
 684 \r
 685 <DT><B>Returns:</B><DD>If only one optionName is defined, than it is returned, if many
 686          option names are defined, then the defaultValue is returned.
 687          Option must have a default value if there are many optionNames to
 688          be valid.</DL>\r
 689 </DD>\r
 690 </DL>\r
 691 <HR>\r
 692 \r
 693 <A NAME="equals(java.lang.Object)"><!-- --></A><H3>\r
 694 equals</H3>\r
 695 <PRE>\r
 696 public boolean <B>equals</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>&nbsp;obj)</PRE>\r
 697 <DL>\r
 698 <DD><DL>\r
 699 <DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A></CODE> in class <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></DL>\r
 700 </DD>\r
 701 <DD><DL>\r
 702 </DL>\r
 703 </DD>\r
 704 </DL>\r
 705 <HR>\r
 706 \r
 707 <A NAME="hashCode()"><!-- --></A><H3>\r
 708 hashCode</H3>\r
 709 <PRE>\r
 710 public int <B>hashCode</B>()</PRE>\r
 711 <DL>\r
 712 <DD><DL>\r
 713 <DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A></CODE> in class <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></DL>\r
 714 </DD>\r
 715 <DD><DL>\r
 716 </DL>\r
 717 </DD>\r
 718 </DL>\r
 719 <HR>\r
 720 \r
 721 <A NAME="getPossibleValues()"><!-- --></A><H3>\r
 722 getPossibleValues</H3>\r
 723 <PRE>\r
 724 public <A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A>&lt;<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&gt; <B>getPossibleValues</B>()</PRE>\r
 725 <DL>\r
 726 <DD>List of possible optionNames\r
 727 <P>\r
 728 <DD><DL>\r
 729 <DT><B>Specified by:</B><DD><CODE><A HREF="../../compbio/metadata/Argument.html#getPossibleValues()">getPossibleValues</A></CODE> in interface <CODE><A HREF="../../compbio/metadata/Argument.html" title="interface in compbio.metadata">Argument</A>&lt;<A HREF="../../compbio/metadata/Option.html" title="type parameter in Option">T</A>&gt;</CODE></DL>\r
 730 </DD>\r
 731 <DD><DL>\r
 732 \r
 733 <DT><B>Returns:</B><DD>List of values allowed for an Argument</DL>\r
 734 </DD>\r
 735 </DL>\r
 736 <HR>\r
 737 \r
 738 <A NAME="setValue(java.lang.String)"><!-- --></A><H3>\r
 739 setValue</H3>\r
 740 <PRE>\r
 741 public void <B>setValue</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;dValue)\r
 742               throws <A HREF="../../compbio/metadata/WrongParameterException.html" title="class in compbio.metadata">WrongParameterException</A></PRE>\r
 743 <DL>\r
 744 <DD><B>Description copied from interface: <CODE><A HREF="../../compbio/metadata/Argument.html#setValue(java.lang.String)">Argument</A></CODE></B></DD>\r
 745 <DD>Set default values for the parameter or an option\r
 746 <P>\r
 747 <DD><DL>\r
 748 <DT><B>Specified by:</B><DD><CODE><A HREF="../../compbio/metadata/Argument.html#setValue(java.lang.String)">setValue</A></CODE> in interface <CODE><A HREF="../../compbio/metadata/Argument.html" title="interface in compbio.metadata">Argument</A>&lt;<A HREF="../../compbio/metadata/Option.html" title="type parameter in Option">T</A>&gt;</CODE></DL>\r
 749 </DD>\r
 750 <DD><DL>\r
 751 <DT><B>Parameters:</B><DD><CODE>dValue</CODE> - the value to be set\r
 752 <DT><B>Throws:</B>\r
 753 <DD><CODE><A HREF="../../compbio/metadata/WrongParameterException.html" title="class in compbio.metadata">WrongParameterException</A></CODE> - - when the value to be set is illegal. Wrong value for
 754              numeric parameter is the value defined outside it , for
 755              string type parameter, wrong value is the one which is not
 756              listed in possible values list<DT><B>See Also:</B><DD><A HREF="../../compbio/metadata/ValueConstrain.html" title="class in compbio.metadata"><CODE>ValueConstrain</CODE></A></DL>\r
 757 </DD>\r
 758 </DL>\r
 759 <!-- ========= END OF CLASS DATA ========= -->\r
 760 <HR>\r
 761 \r
 762 \r
 763 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
 764 <A NAME="navbar_bottom"><!-- --></A>\r
 765 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>\r
 766 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
 767 <TR>\r
 768 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
 769 <A NAME="navbar_bottom_firstrow"><!-- --></A>\r
 770 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
 771   <TR ALIGN="center" VALIGN="top">\r
 772   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
 773   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
 774   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
 775   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Option.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
 776   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
 777   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
 778   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
 779   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
 780   </TR>\r
 781 </TABLE>\r
 782 </TD>\r
 783 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
 784 </EM>\r
 785 </TD>\r
 786 </TR>\r
 787 \r
 788 <TR>\r
 789 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 790 &nbsp;<A HREF="../../compbio/metadata/LimitsManager.html" title="class in compbio.metadata"><B>PREV CLASS</B></A>&nbsp;\r
 791 &nbsp;<A HREF="../../compbio/metadata/Parameter.html" title="class in compbio.metadata"><B>NEXT CLASS</B></A></FONT></TD>\r
 792 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 793   <A HREF="../../index.html?compbio/metadata/Option.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
 794 &nbsp;<A HREF="Option.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
 795 &nbsp;<SCRIPT type="text/javascript">\r
 796   <!--\r
 797   if(window==top) {\r
 798     document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');\r
 799   }\r
 800   //-->\r
 801 </SCRIPT>\r
 802 <NOSCRIPT>\r
 803   <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>\r
 804 </NOSCRIPT>\r
 805 \r
 806 \r
 807 </FONT></TD>\r
 808 </TR>\r
 809 <TR>\r
 810 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 811   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
 812 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 813 DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
 814 </TR>\r
 815 </TABLE>\r
 816 <A NAME="skip-navbar_bottom"></A>\r
 817 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
 818 \r
 819 <HR>\r
 820 \r
 821 </BODY>\r
 822 </HTML>\r