JWS-109 & JWS-116 Regenerated the JABAWS JavaDoc (with eclipse java 8) and moved...
[jabaws.git] / website / docs / dm_javadoc / compbio / data / sequence / Program.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:31:59 BST 2017 -->
6 <title>Program</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="Program";
16         }
17     }
18     catch(err) {
19     }
20 //-->
21 var methods = {"i0":9,"i1":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/Program.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/data/sequence/IUPredResult.html" title="enum in compbio.data.sequence"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
53 <li><a href="../../../compbio/data/sequence/Range.html" title="class in compbio.data.sequence"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
54 </ul>
55 <ul class="navList">
56 <li><a href="../../../index.html?compbio/data/sequence/Program.html" target="_top">Frames</a></li>
57 <li><a href="Program.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><a href="#enum.constant.summary">Enum Constants</a>&nbsp;|&nbsp;</li>
79 <li>Field&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><a href="#enum.constant.detail">Enum Constants</a>&nbsp;|&nbsp;</li>
85 <li>Field&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.data.sequence</div>
96 <h2 title="Enum Program" class="title">Enum Program</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>java.lang.Enum&lt;<a href="../../../compbio/data/sequence/Program.html" title="enum in compbio.data.sequence">Program</a>&gt;</li>
104 <li>
105 <ul class="inheritance">
106 <li>compbio.data.sequence.Program</li>
107 </ul>
108 </li>
109 </ul>
110 </li>
111 </ul>
112 <div class="description">
113 <ul class="blockList">
114 <li class="blockList">
115 <dl>
116 <dt>All Implemented Interfaces:</dt>
117 <dd>java.io.Serializable, java.lang.Comparable&lt;<a href="../../../compbio/data/sequence/Program.html" title="enum in compbio.data.sequence">Program</a>&gt;</dd>
118 </dl>
119 <hr>
120 <br>
121 <pre>public enum <span class="typeNameLabel">Program</span>
122 extends java.lang.Enum&lt;<a href="../../../compbio/data/sequence/Program.html" title="enum in compbio.data.sequence">Program</a>&gt;</pre>
123 <div class="block">The list of programmes that can produce alignments</div>
124 <dl>
125 <dt><span class="simpleTagLabel">Author:</span></dt>
126 <dd>pvtroshin</dd>
127 </dl>
128 </li>
129 </ul>
130 </div>
131 <div class="summary">
132 <ul class="blockList">
133 <li class="blockList">
134 <!-- =========== ENUM CONSTANT SUMMARY =========== -->
135 <ul class="blockList">
136 <li class="blockList"><a name="enum.constant.summary">
137 <!--   -->
138 </a>
139 <h3>Enum Constant Summary</h3>
140 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation">
141 <caption><span>Enum Constants</span><span class="tabEnd">&nbsp;</span></caption>
142 <tr>
143 <th class="colOne" scope="col">Enum Constant and Description</th>
144 </tr>
145 <tr class="altColor">
146 <td class="colOne"><code><span class="memberNameLink"><a href="../../../compbio/data/sequence/Program.html#CLUSTAL">CLUSTAL</a></span></code>
147 <div class="block">ClustalW</div>
148 </td>
149 </tr>
150 <tr class="rowColor">
151 <td class="colOne"><code><span class="memberNameLink"><a href="../../../compbio/data/sequence/Program.html#ClustalO">ClustalO</a></span></code>
152 <div class="block">ClustalO</div>
153 </td>
154 </tr>
155 <tr class="altColor">
156 <td class="colOne"><code><span class="memberNameLink"><a href="../../../compbio/data/sequence/Program.html#GLprobs">GLprobs</a></span></code>
157 <div class="block">GLprobs</div>
158 </td>
159 </tr>
160 <tr class="rowColor">
161 <td class="colOne"><code><span class="memberNameLink"><a href="../../../compbio/data/sequence/Program.html#Mafft">Mafft</a></span></code>
162 <div class="block">Mafft</div>
163 </td>
164 </tr>
165 <tr class="altColor">
166 <td class="colOne"><code><span class="memberNameLink"><a href="../../../compbio/data/sequence/Program.html#MSAprobs">MSAprobs</a></span></code>
167 <div class="block">MSAprobs</div>
168 </td>
169 </tr>
170 <tr class="rowColor">
171 <td class="colOne"><code><span class="memberNameLink"><a href="../../../compbio/data/sequence/Program.html#Muscle">Muscle</a></span></code>
172 <div class="block">Muscle</div>
173 </td>
174 </tr>
175 <tr class="altColor">
176 <td class="colOne"><code><span class="memberNameLink"><a href="../../../compbio/data/sequence/Program.html#Probcons">Probcons</a></span></code>
177 <div class="block">Probcons</div>
178 </td>
179 </tr>
180 <tr class="rowColor">
181 <td class="colOne"><code><span class="memberNameLink"><a href="../../../compbio/data/sequence/Program.html#Tcoffee">Tcoffee</a></span></code>
182 <div class="block">Tcoffee</div>
183 </td>
184 </tr>
185 </table>
186 </li>
187 </ul>
188 <!-- ========== METHOD SUMMARY =========== -->
189 <ul class="blockList">
190 <li class="blockList"><a name="method.summary">
191 <!--   -->
192 </a>
193 <h3>Method Summary</h3>
194 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
195 <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>
196 <tr>
197 <th class="colFirst" scope="col">Modifier and Type</th>
198 <th class="colLast" scope="col">Method and Description</th>
199 </tr>
200 <tr id="i0" class="altColor">
201 <td class="colFirst"><code>static <a href="../../../compbio/data/sequence/Program.html" title="enum in compbio.data.sequence">Program</a></code></td>
202 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/data/sequence/Program.html#valueOf-java.lang.String-">valueOf</a></span>(java.lang.String&nbsp;name)</code>
203 <div class="block">Returns the enum constant of this type with the specified name.</div>
204 </td>
205 </tr>
206 <tr id="i1" class="rowColor">
207 <td class="colFirst"><code>static <a href="../../../compbio/data/sequence/Program.html" title="enum in compbio.data.sequence">Program</a>[]</code></td>
208 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/data/sequence/Program.html#values--">values</a></span>()</code>
209 <div class="block">Returns an array containing the constants of this enum type, in
210 the order they are declared.</div>
211 </td>
212 </tr>
213 </table>
214 <ul class="blockList">
215 <li class="blockList"><a name="methods.inherited.from.class.java.lang.Enum">
216 <!--   -->
217 </a>
218 <h3>Methods inherited from class&nbsp;java.lang.Enum</h3>
219 <code>clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf</code></li>
220 </ul>
221 <ul class="blockList">
222 <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
223 <!--   -->
224 </a>
225 <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
226 <code>getClass, notify, notifyAll, wait, wait, wait</code></li>
227 </ul>
228 </li>
229 </ul>
230 </li>
231 </ul>
232 </div>
233 <div class="details">
234 <ul class="blockList">
235 <li class="blockList">
236 <!-- ============ ENUM CONSTANT DETAIL =========== -->
237 <ul class="blockList">
238 <li class="blockList"><a name="enum.constant.detail">
239 <!--   -->
240 </a>
241 <h3>Enum Constant Detail</h3>
242 <a name="CLUSTAL">
243 <!--   -->
244 </a>
245 <ul class="blockList">
246 <li class="blockList">
247 <h4>CLUSTAL</h4>
248 <pre>public static final&nbsp;<a href="../../../compbio/data/sequence/Program.html" title="enum in compbio.data.sequence">Program</a> CLUSTAL</pre>
249 <div class="block">ClustalW</div>
250 </li>
251 </ul>
252 <a name="ClustalO">
253 <!--   -->
254 </a>
255 <ul class="blockList">
256 <li class="blockList">
257 <h4>ClustalO</h4>
258 <pre>public static final&nbsp;<a href="../../../compbio/data/sequence/Program.html" title="enum in compbio.data.sequence">Program</a> ClustalO</pre>
259 <div class="block">ClustalO</div>
260 </li>
261 </ul>
262 <a name="Mafft">
263 <!--   -->
264 </a>
265 <ul class="blockList">
266 <li class="blockList">
267 <h4>Mafft</h4>
268 <pre>public static final&nbsp;<a href="../../../compbio/data/sequence/Program.html" title="enum in compbio.data.sequence">Program</a> Mafft</pre>
269 <div class="block">Mafft</div>
270 </li>
271 </ul>
272 <a name="Muscle">
273 <!--   -->
274 </a>
275 <ul class="blockList">
276 <li class="blockList">
277 <h4>Muscle</h4>
278 <pre>public static final&nbsp;<a href="../../../compbio/data/sequence/Program.html" title="enum in compbio.data.sequence">Program</a> Muscle</pre>
279 <div class="block">Muscle</div>
280 </li>
281 </ul>
282 <a name="Tcoffee">
283 <!--   -->
284 </a>
285 <ul class="blockList">
286 <li class="blockList">
287 <h4>Tcoffee</h4>
288 <pre>public static final&nbsp;<a href="../../../compbio/data/sequence/Program.html" title="enum in compbio.data.sequence">Program</a> Tcoffee</pre>
289 <div class="block">Tcoffee</div>
290 </li>
291 </ul>
292 <a name="Probcons">
293 <!--   -->
294 </a>
295 <ul class="blockList">
296 <li class="blockList">
297 <h4>Probcons</h4>
298 <pre>public static final&nbsp;<a href="../../../compbio/data/sequence/Program.html" title="enum in compbio.data.sequence">Program</a> Probcons</pre>
299 <div class="block">Probcons</div>
300 </li>
301 </ul>
302 <a name="MSAprobs">
303 <!--   -->
304 </a>
305 <ul class="blockList">
306 <li class="blockList">
307 <h4>MSAprobs</h4>
308 <pre>public static final&nbsp;<a href="../../../compbio/data/sequence/Program.html" title="enum in compbio.data.sequence">Program</a> MSAprobs</pre>
309 <div class="block">MSAprobs</div>
310 </li>
311 </ul>
312 <a name="GLprobs">
313 <!--   -->
314 </a>
315 <ul class="blockListLast">
316 <li class="blockList">
317 <h4>GLprobs</h4>
318 <pre>public static final&nbsp;<a href="../../../compbio/data/sequence/Program.html" title="enum in compbio.data.sequence">Program</a> GLprobs</pre>
319 <div class="block">GLprobs</div>
320 </li>
321 </ul>
322 </li>
323 </ul>
324 <!-- ============ METHOD DETAIL ========== -->
325 <ul class="blockList">
326 <li class="blockList"><a name="method.detail">
327 <!--   -->
328 </a>
329 <h3>Method Detail</h3>
330 <a name="values--">
331 <!--   -->
332 </a>
333 <ul class="blockList">
334 <li class="blockList">
335 <h4>values</h4>
336 <pre>public static&nbsp;<a href="../../../compbio/data/sequence/Program.html" title="enum in compbio.data.sequence">Program</a>[]&nbsp;values()</pre>
337 <div class="block">Returns an array containing the constants of this enum type, in
338 the order they are declared.  This method may be used to iterate
339 over the constants as follows:
340 <pre>
341 for (Program c : Program.values())
342 &nbsp;   System.out.println(c);
343 </pre></div>
344 <dl>
345 <dt><span class="returnLabel">Returns:</span></dt>
346 <dd>an array containing the constants of this enum type, in the order they are declared</dd>
347 </dl>
348 </li>
349 </ul>
350 <a name="valueOf-java.lang.String-">
351 <!--   -->
352 </a>
353 <ul class="blockListLast">
354 <li class="blockList">
355 <h4>valueOf</h4>
356 <pre>public static&nbsp;<a href="../../../compbio/data/sequence/Program.html" title="enum in compbio.data.sequence">Program</a>&nbsp;valueOf(java.lang.String&nbsp;name)</pre>
357 <div class="block">Returns the enum constant of this type with the specified name.
358 The string must match <i>exactly</i> an identifier used to declare an
359 enum constant in this type.  (Extraneous whitespace characters are 
360 not permitted.)</div>
361 <dl>
362 <dt><span class="paramLabel">Parameters:</span></dt>
363 <dd><code>name</code> - the name of the enum constant to be returned.</dd>
364 <dt><span class="returnLabel">Returns:</span></dt>
365 <dd>the enum constant with the specified name</dd>
366 <dt><span class="throwsLabel">Throws:</span></dt>
367 <dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant with the specified name</dd>
368 <dd><code>java.lang.NullPointerException</code> - if the argument is null</dd>
369 </dl>
370 </li>
371 </ul>
372 </li>
373 </ul>
374 </li>
375 </ul>
376 </div>
377 </div>
378 <!-- ========= END OF CLASS DATA ========= -->
379 <!-- ======= START OF BOTTOM NAVBAR ====== -->
380 <div class="bottomNav"><a name="navbar.bottom">
381 <!--   -->
382 </a>
383 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
384 <a name="navbar.bottom.firstrow">
385 <!--   -->
386 </a>
387 <ul class="navList" title="Navigation">
388 <li><a href="../../../overview-summary.html">Overview</a></li>
389 <li><a href="package-summary.html">Package</a></li>
390 <li class="navBarCell1Rev">Class</li>
391 <li><a href="class-use/Program.html">Use</a></li>
392 <li><a href="package-tree.html">Tree</a></li>
393 <li><a href="../../../deprecated-list.html">Deprecated</a></li>
394 <li><a href="../../../index-files/index-1.html">Index</a></li>
395 <li><a href="../../../help-doc.html">Help</a></li>
396 </ul>
397 </div>
398 <div class="subNav">
399 <ul class="navList">
400 <li><a href="../../../compbio/data/sequence/IUPredResult.html" title="enum in compbio.data.sequence"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
401 <li><a href="../../../compbio/data/sequence/Range.html" title="class in compbio.data.sequence"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
402 </ul>
403 <ul class="navList">
404 <li><a href="../../../index.html?compbio/data/sequence/Program.html" target="_top">Frames</a></li>
405 <li><a href="Program.html" target="_top">No&nbsp;Frames</a></li>
406 </ul>
407 <ul class="navList" id="allclasses_navbar_bottom">
408 <li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
409 </ul>
410 <div>
411 <script type="text/javascript"><!--
412   allClassesLink = document.getElementById("allclasses_navbar_bottom");
413   if(window==top) {
414     allClassesLink.style.display = "block";
415   }
416   else {
417     allClassesLink.style.display = "none";
418   }
419   //-->
420 </script>
421 </div>
422 <div>
423 <ul class="subNavList">
424 <li>Summary:&nbsp;</li>
425 <li>Nested&nbsp;|&nbsp;</li>
426 <li><a href="#enum.constant.summary">Enum Constants</a>&nbsp;|&nbsp;</li>
427 <li>Field&nbsp;|&nbsp;</li>
428 <li><a href="#method.summary">Method</a></li>
429 </ul>
430 <ul class="subNavList">
431 <li>Detail:&nbsp;</li>
432 <li><a href="#enum.constant.detail">Enum Constants</a>&nbsp;|&nbsp;</li>
433 <li>Field&nbsp;|&nbsp;</li>
434 <li><a href="#method.detail">Method</a></li>
435 </ul>
436 </div>
437 <a name="skip.navbar.bottom">
438 <!--   -->
439 </a></div>
440 <!-- ======== END OF BOTTOM NAVBAR ======= -->
441 </body>
442 </html>