1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
5 <!-- Generated by javadoc (1.8.0_121) on Fri Apr 21 15:31:59 BST 2017 -->
7 <meta name="date" content="2017-04-21">
8 <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
9 <script type="text/javascript" src="../../script.js"></script>
12 <script type="text/javascript"><!--
14 if (location.href.indexOf('is-external=true') == -1) {
15 parent.document.title="Option";
21 var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":9};
22 var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
23 var altColor = "altColor";
24 var rowColor = "rowColor";
25 var tableTab = "tableTab";
26 var activeTableTab = "activeTableTab";
29 <div>JavaScript is disabled on your browser.</div>
31 <!-- ========= START OF TOP NAVBAR ======= -->
32 <div class="topNav"><a name="navbar.top">
35 <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
36 <a name="navbar.top.firstrow">
39 <ul class="navList" title="Navigation">
40 <li><a href="../../overview-summary.html">Overview</a></li>
41 <li><a href="package-summary.html">Package</a></li>
42 <li class="navBarCell1Rev">Class</li>
43 <li><a href="class-use/Option.html">Use</a></li>
44 <li><a href="package-tree.html">Tree</a></li>
45 <li><a href="../../deprecated-list.html">Deprecated</a></li>
46 <li><a href="../../index-files/index-1.html">Index</a></li>
47 <li><a href="../../help-doc.html">Help</a></li>
52 <li><a href="../../compbio/metadata/LimitsManager.html" title="class in compbio.metadata"><span class="typeNameLink">Prev Class</span></a></li>
53 <li><a href="../../compbio/metadata/Parameter.html" title="class in compbio.metadata"><span class="typeNameLink">Next Class</span></a></li>
56 <li><a href="../../index.html?compbio/metadata/Option.html" target="_top">Frames</a></li>
57 <li><a href="Option.html" target="_top">No Frames</a></li>
59 <ul class="navList" id="allclasses_navbar_top">
60 <li><a href="../../allclasses-noframe.html">All Classes</a></li>
63 <script type="text/javascript"><!--
64 allClassesLink = document.getElementById("allclasses_navbar_top");
66 allClassesLink.style.display = "block";
69 allClassesLink.style.display = "none";
75 <ul class="subNavList">
76 <li>Summary: </li>
77 <li>Nested | </li>
78 <li><a href="#field.summary">Field</a> | </li>
79 <li><a href="#constructor.summary">Constr</a> | </li>
80 <li><a href="#method.summary">Method</a></li>
82 <ul class="subNavList">
83 <li>Detail: </li>
84 <li><a href="#field.detail">Field</a> | </li>
85 <li><a href="#constructor.detail">Constr</a> | </li>
86 <li><a href="#method.detail">Method</a></li>
89 <a name="skip.navbar.top">
92 <!-- ========= END OF TOP NAVBAR ========= -->
93 <!-- ======== START OF CLASS DATA ======== -->
95 <div class="subTitle">compbio.metadata</div>
96 <h2 title="Class Option" class="title">Class Option<T></h2>
98 <div class="contentContainer">
99 <ul class="inheritance">
100 <li>java.lang.Object</li>
102 <ul class="inheritance">
103 <li>compbio.metadata.Option<T></li>
107 <div class="description">
108 <ul class="blockList">
109 <li class="blockList">
111 <dt><span class="paramLabel">Type Parameters:</span></dt>
112 <dd><code>T</code> - type of executable</dd>
115 <dt>All Implemented Interfaces:</dt>
116 <dd><a href="../../compbio/metadata/Argument.html" title="interface in compbio.metadata">Argument</a><T></dd>
119 <dt>Direct Known Subclasses:</dt>
120 <dd><a href="../../compbio/metadata/Parameter.html" title="class in compbio.metadata">Parameter</a></dd>
124 <pre>public class <span class="typeNameLabel">Option<T></span>
125 extends java.lang.Object
126 implements <a href="../../compbio/metadata/Argument.html" title="interface in compbio.metadata">Argument</a><T></pre>
127 <div class="block">Command line option/flag or multiple exclusive options with no value. Example
128 -protein, -dna, -auto</div>
130 <dt><span class="simpleTagLabel">Version:</span></dt>
131 <dd>1.0 October 2009</dd>
132 <dt><span class="simpleTagLabel">Author:</span></dt>
138 <div class="summary">
139 <ul class="blockList">
140 <li class="blockList">
141 <!-- =========== FIELD SUMMARY =========== -->
142 <ul class="blockList">
143 <li class="blockList"><a name="field.summary">
146 <h3>Field Summary</h3>
147 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
148 <caption><span>Fields</span><span class="tabEnd"> </span></caption>
150 <th class="colFirst" scope="col">Modifier and Type</th>
151 <th class="colLast" scope="col">Field and Description</th>
153 <tr class="altColor">
154 <td class="colFirst"><code>private java.net.URL</code></td>
155 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/metadata/Option.html#basicURL">basicURL</a></span></code> </td>
157 <tr class="rowColor">
158 <td class="colFirst"><code>protected java.lang.String</code></td>
159 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/metadata/Option.html#defaultValue">defaultValue</a></span></code> </td>
161 <tr class="altColor">
162 <td class="colFirst"><code>protected java.lang.String</code></td>
163 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/metadata/Option.html#description">description</a></span></code> </td>
165 <tr class="rowColor">
166 <td class="colFirst"><code>protected java.lang.String</code></td>
167 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/metadata/Option.html#furtherDetails">furtherDetails</a></span></code> </td>
169 <tr class="altColor">
170 <td class="colFirst"><code>protected boolean</code></td>
171 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/metadata/Option.html#isRequired">isRequired</a></span></code> </td>
173 <tr class="rowColor">
174 <td class="colFirst"><code>protected java.lang.String</code></td>
175 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/metadata/Option.html#name">name</a></span></code> </td>
177 <tr class="altColor">
178 <td class="colFirst"><code>(package private) java.util.Set<java.lang.String></code></td>
179 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/metadata/Option.html#optionNames">optionNames</a></span></code> </td>
184 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
185 <ul class="blockList">
186 <li class="blockList"><a name="constructor.summary">
189 <h3>Constructor Summary</h3>
190 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
191 <caption><span>Constructors</span><span class="tabEnd"> </span></caption>
193 <th class="colOne" scope="col">Constructor and Description</th>
195 <tr class="altColor">
196 <td class="colOne"><code><span class="memberNameLink"><a href="../../compbio/metadata/Option.html#Option--">Option</a></span>()</code> </td>
198 <tr class="rowColor">
199 <td class="colOne"><code><span class="memberNameLink"><a href="../../compbio/metadata/Option.html#Option-java.lang.String-java.lang.String-">Option</a></span>(java.lang.String name,
200 java.lang.String description)</code> </td>
205 <!-- ========== METHOD SUMMARY =========== -->
206 <ul class="blockList">
207 <li class="blockList"><a name="method.summary">
210 <h3>Method Summary</h3>
211 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
212 <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
214 <th class="colFirst" scope="col">Modifier and Type</th>
215 <th class="colLast" scope="col">Method and Description</th>
217 <tr id="i0" class="altColor">
218 <td class="colFirst"><code>java.util.Set<java.lang.String></code></td>
219 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/metadata/Option.html#addOptionNames-java.lang.String...-">addOptionNames</a></span>(java.lang.String... value)</code>
220 <div class="block">Adds an option to the optionName list</div>
223 <tr id="i1" class="rowColor">
224 <td class="colFirst"><code>boolean</code></td>
225 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/metadata/Option.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object obj)</code> </td>
227 <tr id="i2" class="altColor">
228 <td class="colFirst"><code>java.net.URL</code></td>
229 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/metadata/Option.html#getBasicURL--">getBasicURL</a></span>()</code> </td>
231 <tr id="i3" class="rowColor">
232 <td class="colFirst"><code>java.lang.String</code></td>
233 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/metadata/Option.html#getDefaultValue--">getDefaultValue</a></span>()</code>
234 <div class="block">A default value of the option.</div>
237 <tr id="i4" class="altColor">
238 <td class="colFirst"><code>java.lang.String</code></td>
239 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/metadata/Option.html#getDescription--">getDescription</a></span>()</code>
240 <div class="block">A long description of the Option</div>
243 <tr id="i5" class="rowColor">
244 <td class="colFirst"><code>java.lang.String</code></td>
245 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/metadata/Option.html#getFurtherDetails--">getFurtherDetails</a></span>()</code>
246 <div class="block">The URL where further details about the option can be found</div>
249 <tr id="i6" class="altColor">
250 <td class="colFirst"><code>java.lang.String</code></td>
251 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/metadata/Option.html#getName--">getName</a></span>()</code>
252 <div class="block">Human readable name of the option</div>
255 <tr id="i7" class="rowColor">
256 <td class="colFirst"><code>java.util.List<java.lang.String></code></td>
257 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/metadata/Option.html#getOptionNames--">getOptionNames</a></span>()</code> </td>
259 <tr id="i8" class="altColor">
260 <td class="colFirst"><code>java.util.List<java.lang.String></code></td>
261 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/metadata/Option.html#getPossibleValues--">getPossibleValues</a></span>()</code>
262 <div class="block">List of possible optionNames</div>
265 <tr id="i9" class="rowColor">
266 <td class="colFirst"><code>int</code></td>
267 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/metadata/Option.html#hashCode--">hashCode</a></span>()</code> </td>
269 <tr id="i10" class="altColor">
270 <td class="colFirst"><code>boolean</code></td>
271 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/metadata/Option.html#isRequired--">isRequired</a></span>()</code>
272 <div class="block">Flag that indicated that this option must be specified in the command
273 line for an executable to run</div>
276 <tr id="i11" class="rowColor">
277 <td class="colFirst"><code>void</code></td>
278 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/metadata/Option.html#setBasicURL-java.net.URL-">setBasicURL</a></span>(java.net.URL url)</code> </td>
280 <tr id="i12" class="altColor">
281 <td class="colFirst"><code>void</code></td>
282 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/metadata/Option.html#setDefaultValue-java.lang.String-">setDefaultValue</a></span>(java.lang.String defaultVal)</code>
283 <div class="block">Sets one of the values defined in optionList as default.</div>
286 <tr id="i13" class="rowColor">
287 <td class="colFirst"><code>void</code></td>
288 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/metadata/Option.html#setDescription-java.lang.String-">setDescription</a></span>(java.lang.String description)</code> </td>
290 <tr id="i14" class="altColor">
291 <td class="colFirst"><code>void</code></td>
292 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/metadata/Option.html#setFurtherDetails-java.lang.String-">setFurtherDetails</a></span>(java.lang.String furtherDetails)</code> </td>
294 <tr id="i15" class="rowColor">
295 <td class="colFirst"><code>void</code></td>
296 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/metadata/Option.html#setName-java.lang.String-">setName</a></span>(java.lang.String name)</code> </td>
298 <tr id="i16" class="altColor">
299 <td class="colFirst"><code>void</code></td>
300 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/metadata/Option.html#setOptionNames-java.util.Set-">setOptionNames</a></span>(java.util.Set<java.lang.String> optionNames)</code> </td>
302 <tr id="i17" class="rowColor">
303 <td class="colFirst"><code>void</code></td>
304 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/metadata/Option.html#setRequired-boolean-">setRequired</a></span>(boolean isRequired)</code> </td>
306 <tr id="i18" class="altColor">
307 <td class="colFirst"><code>void</code></td>
308 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/metadata/Option.html#setValue-java.lang.String-">setValue</a></span>(java.lang.String dValue)</code>
309 <div class="block">Set default values for the parameter or an option</div>
312 <tr id="i19" class="rowColor">
313 <td class="colFirst"><code>java.lang.String</code></td>
314 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/metadata/Option.html#toCommand-java.lang.String-">toCommand</a></span>(java.lang.String nameValueSeparator)</code>
315 <div class="block">Convert the option to the command string.</div>
318 <tr id="i20" class="altColor">
319 <td class="colFirst"><code>java.lang.String</code></td>
320 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/metadata/Option.html#toString--">toString</a></span>()</code> </td>
322 <tr id="i21" class="rowColor">
323 <td class="colFirst"><code>(package private) void</code></td>
324 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/metadata/Option.html#validate--">validate</a></span>()</code>
325 <div class="block">Validate the option</div>
328 <tr id="i22" class="altColor">
329 <td class="colFirst"><code>(package private) static boolean</code></td>
330 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/metadata/Option.html#valueExist-java.lang.String-java.util.List-">valueExist</a></span>(java.lang.String testValue,
331 java.util.List<java.lang.String> values)</code> </td>
334 <ul class="blockList">
335 <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
338 <h3>Methods inherited from class java.lang.Object</h3>
339 <code>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li>
346 <div class="details">
347 <ul class="blockList">
348 <li class="blockList">
349 <!-- ============ FIELD DETAIL =========== -->
350 <ul class="blockList">
351 <li class="blockList"><a name="field.detail">
354 <h3>Field Detail</h3>
355 <a name="description">
358 <ul class="blockList">
359 <li class="blockList">
361 <pre>protected java.lang.String description</pre>
364 <a name="optionNames">
367 <ul class="blockList">
368 <li class="blockList">
370 <pre>java.util.Set<java.lang.String> optionNames</pre>
376 <ul class="blockList">
377 <li class="blockList">
379 <pre>protected java.lang.String name</pre>
382 <a name="isRequired">
385 <ul class="blockList">
386 <li class="blockList">
388 <pre>protected boolean isRequired</pre>
391 <a name="furtherDetails">
394 <ul class="blockList">
395 <li class="blockList">
396 <h4>furtherDetails</h4>
397 <pre>protected java.lang.String furtherDetails</pre>
400 <a name="defaultValue">
403 <ul class="blockList">
404 <li class="blockList">
405 <h4>defaultValue</h4>
406 <pre>protected java.lang.String defaultValue</pre>
412 <ul class="blockListLast">
413 <li class="blockList">
415 <pre>private java.net.URL basicURL</pre>
420 <!-- ========= CONSTRUCTOR DETAIL ======== -->
421 <ul class="blockList">
422 <li class="blockList"><a name="constructor.detail">
425 <h3>Constructor Detail</h3>
429 <ul class="blockList">
430 <li class="blockList">
435 <a name="Option-java.lang.String-java.lang.String-">
438 <ul class="blockListLast">
439 <li class="blockList">
441 <pre>public Option(java.lang.String name,
442 java.lang.String description)</pre>
447 <!-- ============ METHOD DETAIL ========== -->
448 <ul class="blockList">
449 <li class="blockList"><a name="method.detail">
452 <h3>Method Detail</h3>
456 <ul class="blockList">
457 <li class="blockList">
459 <pre>public java.lang.String getName()</pre>
460 <div class="block">Human readable name of the option</div>
462 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
463 <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><<a href="../../compbio/metadata/Option.html" title="type parameter in Option">T</a>></code></dd>
467 <a name="setName-java.lang.String-">
470 <ul class="blockList">
471 <li class="blockList">
473 <pre>public void setName(java.lang.String name)</pre>
476 <a name="setBasicURL-java.net.URL-">
479 <ul class="blockList">
480 <li class="blockList">
482 <pre>public void setBasicURL(java.net.URL url)</pre>
485 <a name="getBasicURL--">
488 <ul class="blockList">
489 <li class="blockList">
491 <pre>public java.net.URL getBasicURL()</pre>
494 <a name="getDescription--">
497 <ul class="blockList">
498 <li class="blockList">
499 <h4>getDescription</h4>
500 <pre>public java.lang.String getDescription()</pre>
501 <div class="block">A long description of the Option</div>
503 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
504 <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><<a href="../../compbio/metadata/Option.html" title="type parameter in Option">T</a>></code></dd>
508 <a name="setDescription-java.lang.String-">
511 <ul class="blockList">
512 <li class="blockList">
513 <h4>setDescription</h4>
514 <pre>public void setDescription(java.lang.String description)</pre>
517 <a name="getFurtherDetails--">
520 <ul class="blockList">
521 <li class="blockList">
522 <h4>getFurtherDetails</h4>
523 <pre>public java.lang.String getFurtherDetails()</pre>
524 <div class="block">The URL where further details about the option can be found</div>
526 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
527 <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><<a href="../../compbio/metadata/Option.html" title="type parameter in Option">T</a>></code></dd>
528 <dt><span class="throwsLabel">Throws:</span></dt>
529 <dd><code>java.net.MalformedURLException</code></dd>
533 <a name="setFurtherDetails-java.lang.String-">
536 <ul class="blockList">
537 <li class="blockList">
538 <h4>setFurtherDetails</h4>
539 <pre>public void setFurtherDetails(java.lang.String furtherDetails)</pre>
542 <a name="getDefaultValue--">
545 <ul class="blockList">
546 <li class="blockList">
547 <h4>getDefaultValue</h4>
548 <pre>public java.lang.String getDefaultValue()</pre>
549 <div class="block">A default value of the option. Defaults to command line argument name
552 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
553 <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><<a href="../../compbio/metadata/Option.html" title="type parameter in Option">T</a>></code></dd>
557 <a name="setDefaultValue-java.lang.String-">
560 <ul class="blockList">
561 <li class="blockList">
562 <h4>setDefaultValue</h4>
563 <pre>public void setDefaultValue(java.lang.String defaultVal)
564 throws <a href="../../compbio/metadata/WrongParameterException.html" title="class in compbio.metadata">WrongParameterException</a></pre>
565 <div class="block">Sets one of the values defined in optionList as default. Attempting set
566 the value not listed there will result in WrongParameter exception</div>
568 <dt><span class="paramLabel">Parameters:</span></dt>
569 <dd><code>defaultVal</code> - </dd>
570 <dt><span class="throwsLabel">Throws:</span></dt>
571 <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</dd>
575 <a name="valueExist-java.lang.String-java.util.List-">
578 <ul class="blockList">
579 <li class="blockList">
581 <pre>static boolean valueExist(java.lang.String testValue,
582 java.util.List<java.lang.String> values)</pre>
585 <a name="isRequired--">
588 <ul class="blockList">
589 <li class="blockList">
591 <pre>public boolean isRequired()</pre>
592 <div class="block">Flag that indicated that this option must be specified in the command
593 line for an executable to run</div>
595 <dt><span class="returnLabel">Returns:</span></dt>
596 <dd>true is the option is required, false otherwise</dd>
600 <a name="setRequired-boolean-">
603 <ul class="blockList">
604 <li class="blockList">
606 <pre>public void setRequired(boolean isRequired)</pre>
609 <a name="getOptionNames--">
612 <ul class="blockList">
613 <li class="blockList">
614 <h4>getOptionNames</h4>
615 <pre>public java.util.List<java.lang.String> getOptionNames()</pre>
617 <dt><span class="returnLabel">Returns:</span></dt>
618 <dd>List of option names</dd>
622 <a name="setOptionNames-java.util.Set-">
625 <ul class="blockList">
626 <li class="blockList">
627 <h4>setOptionNames</h4>
628 <pre>public void setOptionNames(java.util.Set<java.lang.String> optionNames)</pre>
631 <a name="addOptionNames-java.lang.String...-">
634 <ul class="blockList">
635 <li class="blockList">
636 <h4>addOptionNames</h4>
637 <pre>public java.util.Set<java.lang.String> addOptionNames(java.lang.String... value)</pre>
638 <div class="block">Adds an option to the optionName list</div>
640 <dt><span class="paramLabel">Parameters:</span></dt>
641 <dd><code>value</code> - </dd>
642 <dt><span class="returnLabel">Returns:</span></dt>
643 <dd>modified optionName list</dd>
647 <a name="toString--">
650 <ul class="blockList">
651 <li class="blockList">
653 <pre>public java.lang.String toString()</pre>
655 <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
656 <dd><code>toString</code> in class <code>java.lang.Object</code></dd>
660 <a name="toCommand-java.lang.String-">
663 <ul class="blockList">
664 <li class="blockList">
666 <pre>public java.lang.String toCommand(java.lang.String nameValueSeparator)</pre>
667 <div class="block">Convert the option to the command string.</div>
669 <dt><span class="returnLabel">Returns:</span></dt>
670 <dd>If only one optionName is defined, than it is returned, if many
671 option names are defined, then the defaultValue is returned.
672 Option must have a default value if there are many optionNames to
677 <a name="equals-java.lang.Object-">
680 <ul class="blockList">
681 <li class="blockList">
683 <pre>public boolean equals(java.lang.Object obj)</pre>
685 <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
686 <dd><code>equals</code> in class <code>java.lang.Object</code></dd>
690 <a name="hashCode--">
693 <ul class="blockList">
694 <li class="blockList">
696 <pre>public int hashCode()</pre>
698 <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
699 <dd><code>hashCode</code> in class <code>java.lang.Object</code></dd>
703 <a name="getPossibleValues--">
706 <ul class="blockList">
707 <li class="blockList">
708 <h4>getPossibleValues</h4>
709 <pre>public java.util.List<java.lang.String> getPossibleValues()</pre>
710 <div class="block">List of possible optionNames</div>
712 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
713 <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><<a href="../../compbio/metadata/Option.html" title="type parameter in Option">T</a>></code></dd>
714 <dt><span class="returnLabel">Returns:</span></dt>
715 <dd>List of values allowed for an Argument</dd>
719 <a name="setValue-java.lang.String-">
722 <ul class="blockList">
723 <li class="blockList">
725 <pre>public void setValue(java.lang.String dValue)
726 throws <a href="../../compbio/metadata/WrongParameterException.html" title="class in compbio.metadata">WrongParameterException</a></pre>
727 <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../compbio/metadata/Argument.html#setValue-java.lang.String-">Argument</a></code></span></div>
728 <div class="block">Set default values for the parameter or an option</div>
730 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
731 <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><<a href="../../compbio/metadata/Option.html" title="type parameter in Option">T</a>></code></dd>
732 <dt><span class="paramLabel">Parameters:</span></dt>
733 <dd><code>dValue</code> - the value to be set</dd>
734 <dt><span class="throwsLabel">Throws:</span></dt>
735 <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
736 numeric parameter is the value defined outside it , for
737 string type parameter, wrong value is the one which is not
738 listed in possible values list</dd>
739 <dt><span class="seeLabel">See Also:</span></dt>
740 <dd><a href="../../compbio/metadata/ValueConstrain.html" title="class in compbio.metadata"><code>ValueConstrain</code></a></dd>
744 <a name="validate--">
747 <ul class="blockListLast">
748 <li class="blockList">
750 <pre>void validate()
751 throws javax.xml.bind.ValidationException</pre>
752 <div class="block">Validate the option</div>
754 <dt><span class="throwsLabel">Throws:</span></dt>
755 <dd><code>javax.xml.bind.ValidationException</code> - is the option is invalid. This happens if option does not
756 have a default value but have multiple option names, or no
757 option names is defined</dd>
767 <!-- ========= END OF CLASS DATA ========= -->
768 <!-- ======= START OF BOTTOM NAVBAR ====== -->
769 <div class="bottomNav"><a name="navbar.bottom">
772 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
773 <a name="navbar.bottom.firstrow">
776 <ul class="navList" title="Navigation">
777 <li><a href="../../overview-summary.html">Overview</a></li>
778 <li><a href="package-summary.html">Package</a></li>
779 <li class="navBarCell1Rev">Class</li>
780 <li><a href="class-use/Option.html">Use</a></li>
781 <li><a href="package-tree.html">Tree</a></li>
782 <li><a href="../../deprecated-list.html">Deprecated</a></li>
783 <li><a href="../../index-files/index-1.html">Index</a></li>
784 <li><a href="../../help-doc.html">Help</a></li>
789 <li><a href="../../compbio/metadata/LimitsManager.html" title="class in compbio.metadata"><span class="typeNameLink">Prev Class</span></a></li>
790 <li><a href="../../compbio/metadata/Parameter.html" title="class in compbio.metadata"><span class="typeNameLink">Next Class</span></a></li>
793 <li><a href="../../index.html?compbio/metadata/Option.html" target="_top">Frames</a></li>
794 <li><a href="Option.html" target="_top">No Frames</a></li>
796 <ul class="navList" id="allclasses_navbar_bottom">
797 <li><a href="../../allclasses-noframe.html">All Classes</a></li>
800 <script type="text/javascript"><!--
801 allClassesLink = document.getElementById("allclasses_navbar_bottom");
803 allClassesLink.style.display = "block";
806 allClassesLink.style.display = "none";
812 <ul class="subNavList">
813 <li>Summary: </li>
814 <li>Nested | </li>
815 <li><a href="#field.summary">Field</a> | </li>
816 <li><a href="#constructor.summary">Constr</a> | </li>
817 <li><a href="#method.summary">Method</a></li>
819 <ul class="subNavList">
820 <li>Detail: </li>
821 <li><a href="#field.detail">Field</a> | </li>
822 <li><a href="#constructor.detail">Constr</a> | </li>
823 <li><a href="#method.detail">Method</a></li>
826 <a name="skip.navbar.bottom">
829 <!-- ======== END OF BOTTOM NAVBAR ======= -->