website/docs/full_javadoc/compbio/ws/client/CmdHelper.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <!-- NewPage -->
   3 <html lang="en">
   4 <head>
   5 <!-- Generated by javadoc (1.8.0_121) on Fri Apr 21 15:32:49 BST 2017 -->
   6 <title>CmdHelper</title>
   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>
  10 </head>
  11 <body>
  12 <script type="text/javascript"><!--
  13     try {
  14         if (location.href.indexOf('is-external=true') == -1) {
  15             parent.document.title="CmdHelper";
  16         }
  17     }
  18     catch(err) {
  19     }
  20 //-->
  21 var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9};
  22 var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]};
  23 var altColor = "altColor";
  24 var rowColor = "rowColor";
  25 var tableTab = "tableTab";
  26 var activeTableTab = "activeTableTab";
  27 </script>
  28 <noscript>
  29 <div>JavaScript is disabled on your browser.</div>
  30 </noscript>
  31 <!-- ========= START OF TOP NAVBAR ======= -->
  32 <div class="topNav"><a name="navbar.top">
  33 <!--   -->
  34 </a>
  35 <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
  36 <a name="navbar.top.firstrow">
  37 <!--   -->
  38 </a>
  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/CmdHelper.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>
  48 </ul>
  49 </div>
  50 <div class="subNav">
  51 <ul class="navList">
  52 <li><a href="../../../compbio/ws/client/AAConClient.html" title="class in compbio.ws.client"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  53 <li><a href="../../../compbio/ws/client/Constraints.html" title="class in compbio.ws.client"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  54 </ul>
  55 <ul class="navList">
  56 <li><a href="../../../index.html?compbio/ws/client/CmdHelper.html" target="_top">Frames</a></li>
  57 <li><a href="CmdHelper.html" target="_top">No&nbsp;Frames</a></li>
  58 </ul>
  59 <ul class="navList" id="allclasses_navbar_top">
  60 <li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  61 </ul>
  62 <div>
  63 <script type="text/javascript"><!--
  64   allClassesLink = document.getElementById("allclasses_navbar_top");
  65   if(window==top) {
  66     allClassesLink.style.display = "block";
  67   }
  68   else {
  69     allClassesLink.style.display = "none";
  70   }
  71   //-->
  72 </script>
  73 </div>
  74 <div>
  75 <ul class="subNavList">
  76 <li>Summary:&nbsp;</li>
  77 <li>Nested&nbsp;|&nbsp;</li>
  78 <li>Field&nbsp;|&nbsp;</li>
  79 <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  80 <li><a href="#method.summary">Method</a></li>
  81 </ul>
  82 <ul class="subNavList">
  83 <li>Detail:&nbsp;</li>
  84 <li>Field&nbsp;|&nbsp;</li>
  85 <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  86 <li><a href="#method.detail">Method</a></li>
  87 </ul>
  88 </div>
  89 <a name="skip.navbar.top">
  90 <!--   -->
  91 </a></div>
  92 <!-- ========= END OF TOP NAVBAR ========= -->
  93 <!-- ======== START OF CLASS DATA ======== -->
  94 <div class="header">
  95 <div class="subTitle">compbio.ws.client</div>
  96 <h2 title="Class CmdHelper" class="title">Class CmdHelper</h2>
  97 </div>
  98 <div class="contentContainer">
  99 <ul class="inheritance">
 100 <li>java.lang.Object</li>
 101 <li>
 102 <ul class="inheritance">
 103 <li>compbio.ws.client.CmdHelper</li>
 104 </ul>
 105 </li>
 106 </ul>
 107 <div class="description">
 108 <ul class="blockList">
 109 <li class="blockList">
 110 <hr>
 111 <br>
 112 <pre>class <span class="typeNameLabel">CmdHelper</span>
 113 extends java.lang.Object</pre>
 114 </li>
 115 </ul>
 116 </div>
 117 <div class="summary">
 118 <ul class="blockList">
 119 <li class="blockList">
 120 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 121 <ul class="blockList">
 122 <li class="blockList"><a name="constructor.summary">
 123 <!--   -->
 124 </a>
 125 <h3>Constructor Summary</h3>
 126 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
 127 <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
 128 <tr>
 129 <th class="colOne" scope="col">Constructor and Description</th>
 130 </tr>
 131 <tr class="altColor">
 132 <td class="colOne"><code><span class="memberNameLink"><a href="../../../compbio/ws/client/CmdHelper.html#CmdHelper--">CmdHelper</a></span>()</code>&nbsp;</td>
 133 </tr>
 134 </table>
 135 </li>
 136 </ul>
 137 <!-- ========== METHOD SUMMARY =========== -->
 138 <ul class="blockList">
 139 <li class="blockList"><a name="method.summary">
 140 <!--   -->
 141 </a>
 142 <h3>Method Summary</h3>
 143 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
 144 <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
 145 <tr>
 146 <th class="colFirst" scope="col">Modifier and Type</th>
 147 <th class="colLast" scope="col">Method and Description</th>
 148 </tr>
 149 <tr id="i0" class="altColor">
 150 <td class="colFirst"><code>static java.lang.String</code></td>
 151 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/ws/client/CmdHelper.html#getHost-java.lang.String:A-">getHost</a></span>(java.lang.String[]&nbsp;cmd)</code>
 152 <div class="block">Extracts host name from the command line</div>
 153 </td>
 154 </tr>
 155 <tr id="i1" class="rowColor">
 156 <td class="colFirst"><code>(package private) static java.lang.String</code></td>
 157 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/ws/client/CmdHelper.html#getPresetName-java.lang.String:A-">getPresetName</a></span>(java.lang.String[]&nbsp;cmd)</code>
 158 <div class="block">Extracts preset name from the command line is any</div>
 159 </td>
 160 </tr>
 161 <tr id="i2" class="altColor">
 162 <td class="colFirst"><code>static java.lang.String</code></td>
 163 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/ws/client/CmdHelper.html#getServiceName-java.lang.String:A-">getServiceName</a></span>(java.lang.String[]&nbsp;cmd)</code>
 164 <div class="block">Extracts service name from the command line</div>
 165 </td>
 166 </tr>
 167 <tr id="i3" class="rowColor">
 168 <td class="colFirst"><code>(package private) static boolean</code></td>
 169 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/ws/client/CmdHelper.html#keyFound-java.lang.String:A-java.lang.String-">keyFound</a></span>(java.lang.String[]&nbsp;cmd,
 170         java.lang.String&nbsp;key)</code>
 171 <div class="block">Checks whether the key is in the command line</div>
 172 </td>
 173 </tr>
 174 <tr id="i4" class="altColor">
 175 <td class="colFirst"><code>(package private) static boolean</code></td>
 176 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/ws/client/CmdHelper.html#listLimits-java.lang.String:A-">listLimits</a></span>(java.lang.String[]&nbsp;cmd)</code>
 177 <div class="block">Checks whether limitList parameter is in the command line</div>
 178 </td>
 179 </tr>
 180 <tr id="i5" class="rowColor">
 181 <td class="colFirst"><code>(package private) static boolean</code></td>
 182 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/ws/client/CmdHelper.html#listParameters-java.lang.String:A-">listParameters</a></span>(java.lang.String[]&nbsp;cmd)</code>
 183 <div class="block">Searches the command line keys in the array of parameters</div>
 184 </td>
 185 </tr>
 186 <tr id="i6" class="altColor">
 187 <td class="colFirst"><code>(package private) static boolean</code></td>
 188 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/ws/client/CmdHelper.html#listPresets-java.lang.String:A-">listPresets</a></span>(java.lang.String[]&nbsp;cmd)</code>
 189 <div class="block">Check whether presetList is set in the command line</div>
 190 </td>
 191 </tr>
 192 <tr id="i7" class="rowColor">
 193 <td class="colFirst"><code>(package private) static boolean</code></td>
 194 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/ws/client/CmdHelper.html#listServices-java.lang.String:A-">listServices</a></span>(java.lang.String[]&nbsp;cmd)</code>
 195 <div class="block">list available services</div>
 196 </td>
 197 </tr>
 198 <tr id="i8" class="altColor">
 199 <td class="colFirst"><code>(package private) static boolean</code></td>
 200 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/ws/client/CmdHelper.html#testService-java.lang.String:A-">testService</a></span>(java.lang.String[]&nbsp;cmd)</code>
 201 <div class="block">tests service</div>
 202 </td>
 203 </tr>
 204 </table>
 205 <ul class="blockList">
 206 <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
 207 <!--   -->
 208 </a>
 209 <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
 210 <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
 211 </ul>
 212 </li>
 213 </ul>
 214 </li>
 215 </ul>
 216 </div>
 217 <div class="details">
 218 <ul class="blockList">
 219 <li class="blockList">
 220 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 221 <ul class="blockList">
 222 <li class="blockList"><a name="constructor.detail">
 223 <!--   -->
 224 </a>
 225 <h3>Constructor Detail</h3>
 226 <a name="CmdHelper--">
 227 <!--   -->
 228 </a>
 229 <ul class="blockListLast">
 230 <li class="blockList">
 231 <h4>CmdHelper</h4>
 232 <pre>CmdHelper()</pre>
 233 </li>
 234 </ul>
 235 </li>
 236 </ul>
 237 <!-- ============ METHOD DETAIL ========== -->
 238 <ul class="blockList">
 239 <li class="blockList"><a name="method.detail">
 240 <!--   -->
 241 </a>
 242 <h3>Method Detail</h3>
 243 <a name="listPresets-java.lang.String:A-">
 244 <!--   -->
 245 </a>
 246 <ul class="blockList">
 247 <li class="blockList">
 248 <h4>listPresets</h4>
 249 <pre>static&nbsp;boolean&nbsp;listPresets(java.lang.String[]&nbsp;cmd)</pre>
 250 <div class="block">Check whether presetList is set in the command line</div>
 251 <dl>
 252 <dt><span class="paramLabel">Parameters:</span></dt>
 253 <dd><code>cmd</code> - command line options</dd>
 254 <dt><span class="returnLabel">Returns:</span></dt>
 255 <dd>true if presetList is found, false otherwise</dd>
 256 </dl>
 257 </li>
 258 </ul>
 259 <a name="listLimits-java.lang.String:A-">
 260 <!--   -->
 261 </a>
 262 <ul class="blockList">
 263 <li class="blockList">
 264 <h4>listLimits</h4>
 265 <pre>static&nbsp;boolean&nbsp;listLimits(java.lang.String[]&nbsp;cmd)</pre>
 266 <div class="block">Checks whether limitList parameter is in the command line</div>
 267 <dl>
 268 <dt><span class="paramLabel">Parameters:</span></dt>
 269 <dd><code>cmd</code> - - command line options</dd>
 270 <dt><span class="returnLabel">Returns:</span></dt>
 271 <dd>true if it is, false otherwise</dd>
 272 </dl>
 273 </li>
 274 </ul>
 275 <a name="listServices-java.lang.String:A-">
 276 <!--   -->
 277 </a>
 278 <ul class="blockList">
 279 <li class="blockList">
 280 <h4>listServices</h4>
 281 <pre>static&nbsp;boolean&nbsp;listServices(java.lang.String[]&nbsp;cmd)</pre>
 282 <div class="block">list available services</div>
 283 <dl>
 284 <dt><span class="paramLabel">Parameters:</span></dt>
 285 <dd><code>cmd</code> - </dd>
 286 <dt><span class="returnLabel">Returns:</span></dt>
 287 </dl>
 288 </li>
 289 </ul>
 290 <a name="testService-java.lang.String:A-">
 291 <!--   -->
 292 </a>
 293 <ul class="blockList">
 294 <li class="blockList">
 295 <h4>testService</h4>
 296 <pre>static&nbsp;boolean&nbsp;testService(java.lang.String[]&nbsp;cmd)</pre>
 297 <div class="block">tests service</div>
 298 <dl>
 299 <dt><span class="paramLabel">Parameters:</span></dt>
 300 <dd><code>cmd</code> - </dd>
 301 <dt><span class="returnLabel">Returns:</span></dt>
 302 </dl>
 303 </li>
 304 </ul>
 305 <a name="keyFound-java.lang.String:A-java.lang.String-">
 306 <!--   -->
 307 </a>
 308 <ul class="blockList">
 309 <li class="blockList">
 310 <h4>keyFound</h4>
 311 <pre>static&nbsp;boolean&nbsp;keyFound(java.lang.String[]&nbsp;cmd,
 312                         java.lang.String&nbsp;key)</pre>
 313 <div class="block">Checks whether the key is in the command line</div>
 314 <dl>
 315 <dt><span class="paramLabel">Parameters:</span></dt>
 316 <dd><code>cmd</code> - </dd>
 317 <dd><code>key</code> - </dd>
 318 <dt><span class="returnLabel">Returns:</span></dt>
 319 <dd>true if it is, false otherwise</dd>
 320 </dl>
 321 </li>
 322 </ul>
 323 <a name="getPresetName-java.lang.String:A-">
 324 <!--   -->
 325 </a>
 326 <ul class="blockList">
 327 <li class="blockList">
 328 <h4>getPresetName</h4>
 329 <pre>static&nbsp;java.lang.String&nbsp;getPresetName(java.lang.String[]&nbsp;cmd)</pre>
 330 <div class="block">Extracts preset name from the command line is any</div>
 331 <dl>
 332 <dt><span class="paramLabel">Parameters:</span></dt>
 333 <dd><code>cmd</code> - command line options</dd>
 334 <dt><span class="returnLabel">Returns:</span></dt>
 335 <dd>presetName or null if no presets is defined</dd>
 336 </dl>
 337 </li>
 338 </ul>
 339 <a name="getServiceName-java.lang.String:A-">
 340 <!--   -->
 341 </a>
 342 <ul class="blockList">
 343 <li class="blockList">
 344 <h4>getServiceName</h4>
 345 <pre>public static&nbsp;java.lang.String&nbsp;getServiceName(java.lang.String[]&nbsp;cmd)</pre>
 346 <div class="block">Extracts service name from the command line</div>
 347 <dl>
 348 <dt><span class="paramLabel">Parameters:</span></dt>
 349 <dd><code>cmd</code> - command line options</dd>
 350 <dt><span class="returnLabel">Returns:</span></dt>
 351 <dd>service name or null if it is not defined</dd>
 352 </dl>
 353 </li>
 354 </ul>
 355 <a name="getHost-java.lang.String:A-">
 356 <!--   -->
 357 </a>
 358 <ul class="blockList">
 359 <li class="blockList">
 360 <h4>getHost</h4>
 361 <pre>public static&nbsp;java.lang.String&nbsp;getHost(java.lang.String[]&nbsp;cmd)</pre>
 362 <div class="block">Extracts host name from the command line</div>
 363 <dl>
 364 <dt><span class="paramLabel">Parameters:</span></dt>
 365 <dd><code>cmd</code> - command line options</dd>
 366 <dt><span class="returnLabel">Returns:</span></dt>
 367 <dd>host name or null if it is not defined</dd>
 368 </dl>
 369 </li>
 370 </ul>
 371 <a name="listParameters-java.lang.String:A-">
 372 <!--   -->
 373 </a>
 374 <ul class="blockListLast">
 375 <li class="blockList">
 376 <h4>listParameters</h4>
 377 <pre>static&nbsp;boolean&nbsp;listParameters(java.lang.String[]&nbsp;cmd)</pre>
 378 <div class="block">Searches the command line keys in the array of parameters</div>
 379 <dl>
 380 <dt><span class="paramLabel">Parameters:</span></dt>
 381 <dd><code>cmd</code> - command line options</dd>
 382 <dt><span class="returnLabel">Returns:</span></dt>
 383 <dd>true is the list of Parameters is requested, false otherwise</dd>
 384 </dl>
 385 </li>
 386 </ul>
 387 </li>
 388 </ul>
 389 </li>
 390 </ul>
 391 </div>
 392 </div>
 393 <!-- ========= END OF CLASS DATA ========= -->
 394 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 395 <div class="bottomNav"><a name="navbar.bottom">
 396 <!--   -->
 397 </a>
 398 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
 399 <a name="navbar.bottom.firstrow">
 400 <!--   -->
 401 </a>
 402 <ul class="navList" title="Navigation">
 403 <li><a href="../../../overview-summary.html">Overview</a></li>
 404 <li><a href="package-summary.html">Package</a></li>
 405 <li class="navBarCell1Rev">Class</li>
 406 <li><a href="class-use/CmdHelper.html">Use</a></li>
 407 <li><a href="package-tree.html">Tree</a></li>
 408 <li><a href="../../../deprecated-list.html">Deprecated</a></li>
 409 <li><a href="../../../index-files/index-1.html">Index</a></li>
 410 <li><a href="../../../help-doc.html">Help</a></li>
 411 </ul>
 412 </div>
 413 <div class="subNav">
 414 <ul class="navList">
 415 <li><a href="../../../compbio/ws/client/AAConClient.html" title="class in compbio.ws.client"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 416 <li><a href="../../../compbio/ws/client/Constraints.html" title="class in compbio.ws.client"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 417 </ul>
 418 <ul class="navList">
 419 <li><a href="../../../index.html?compbio/ws/client/CmdHelper.html" target="_top">Frames</a></li>
 420 <li><a href="CmdHelper.html" target="_top">No&nbsp;Frames</a></li>
 421 </ul>
 422 <ul class="navList" id="allclasses_navbar_bottom">
 423 <li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
 424 </ul>
 425 <div>
 426 <script type="text/javascript"><!--
 427   allClassesLink = document.getElementById("allclasses_navbar_bottom");
 428   if(window==top) {
 429     allClassesLink.style.display = "block";
 430   }
 431   else {
 432     allClassesLink.style.display = "none";
 433   }
 434   //-->
 435 </script>
 436 </div>
 437 <div>
 438 <ul class="subNavList">
 439 <li>Summary:&nbsp;</li>
 440 <li>Nested&nbsp;|&nbsp;</li>
 441 <li>Field&nbsp;|&nbsp;</li>
 442 <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
 443 <li><a href="#method.summary">Method</a></li>
 444 </ul>
 445 <ul class="subNavList">
 446 <li>Detail:&nbsp;</li>
 447 <li>Field&nbsp;|&nbsp;</li>
 448 <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
 449 <li><a href="#method.detail">Method</a></li>
 450 </ul>
 451 </div>
 452 <a name="skip.navbar.bottom">
 453 <!--   -->
 454 </a></div>
 455 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 456 </body>
 457 </html>