JWS-119 & JWS-116 Fixed the location of the documentation pages. Also fixed the relat...
[jabaws.git] / website / docs / full_javadoc / compbio / data / sequence / RNAStructReader.RNAOut.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>RNAStructReader.RNAOut</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="RNAStructReader.RNAOut";
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/RNAStructReader.RNAOut.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/RNAStructReader.AlifoldResult.html" title="enum in compbio.data.sequence"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
53 <li><a href="../../../compbio/data/sequence/RNAStructScoreManager.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/RNAStructReader.RNAOut.html" target="_top">Frames</a></li>
57 <li><a href="RNAStructReader.RNAOut.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 RNAStructReader.RNAOut" class="title">Enum RNAStructReader.RNAOut</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/RNAStructReader.RNAOut.html" title="enum in compbio.data.sequence">RNAStructReader.RNAOut</a>&gt;</li>
104 <li>
105 <ul class="inheritance">
106 <li>compbio.data.sequence.RNAStructReader.RNAOut</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/RNAStructReader.RNAOut.html" title="enum in compbio.data.sequence">RNAStructReader.RNAOut</a>&gt;</dd>
118 </dl>
119 <dl>
120 <dt>Enclosing class:</dt>
121 <dd><a href="../../../compbio/data/sequence/RNAStructReader.html" title="class in compbio.data.sequence">RNAStructReader</a></dd>
122 </dl>
123 <hr>
124 <br>
125 <pre>static enum <span class="typeNameLabel">RNAStructReader.RNAOut</span>
126 extends java.lang.Enum&lt;<a href="../../../compbio/data/sequence/RNAStructReader.RNAOut.html" title="enum in compbio.data.sequence">RNAStructReader.RNAOut</a>&gt;</pre>
127 </li>
128 </ul>
129 </div>
130 <div class="summary">
131 <ul class="blockList">
132 <li class="blockList">
133 <!-- =========== ENUM CONSTANT SUMMARY =========== -->
134 <ul class="blockList">
135 <li class="blockList"><a name="enum.constant.summary">
136 <!--   -->
137 </a>
138 <h3>Enum Constant Summary</h3>
139 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation">
140 <caption><span>Enum Constants</span><span class="tabEnd">&nbsp;</span></caption>
141 <tr>
142 <th class="colOne" scope="col">Enum Constant and Description</th>
143 </tr>
144 <tr class="altColor">
145 <td class="colOne"><code><span class="memberNameLink"><a href="../../../compbio/data/sequence/RNAStructReader.RNAOut.html#ENERGY">ENERGY</a></span></code>&nbsp;</td>
146 </tr>
147 <tr class="rowColor">
148 <td class="colOne"><code><span class="memberNameLink"><a href="../../../compbio/data/sequence/RNAStructReader.RNAOut.html#FREQ">FREQ</a></span></code>&nbsp;</td>
149 </tr>
150 <tr class="altColor">
151 <td class="colOne"><code><span class="memberNameLink"><a href="../../../compbio/data/sequence/RNAStructReader.RNAOut.html#OTHER">OTHER</a></span></code>&nbsp;</td>
152 </tr>
153 <tr class="rowColor">
154 <td class="colOne"><code><span class="memberNameLink"><a href="../../../compbio/data/sequence/RNAStructReader.RNAOut.html#SEQ">SEQ</a></span></code>&nbsp;</td>
155 </tr>
156 <tr class="altColor">
157 <td class="colOne"><code><span class="memberNameLink"><a href="../../../compbio/data/sequence/RNAStructReader.RNAOut.html#STRUCT">STRUCT</a></span></code>&nbsp;</td>
158 </tr>
159 </table>
160 </li>
161 </ul>
162 <!-- ========== METHOD SUMMARY =========== -->
163 <ul class="blockList">
164 <li class="blockList"><a name="method.summary">
165 <!--   -->
166 </a>
167 <h3>Method Summary</h3>
168 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
169 <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>
170 <tr>
171 <th class="colFirst" scope="col">Modifier and Type</th>
172 <th class="colLast" scope="col">Method and Description</th>
173 </tr>
174 <tr id="i0" class="altColor">
175 <td class="colFirst"><code>static <a href="../../../compbio/data/sequence/RNAStructReader.RNAOut.html" title="enum in compbio.data.sequence">RNAStructReader.RNAOut</a></code></td>
176 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/data/sequence/RNAStructReader.RNAOut.html#valueOf-java.lang.String-">valueOf</a></span>(java.lang.String&nbsp;name)</code>
177 <div class="block">Returns the enum constant of this type with the specified name.</div>
178 </td>
179 </tr>
180 <tr id="i1" class="rowColor">
181 <td class="colFirst"><code>static <a href="../../../compbio/data/sequence/RNAStructReader.RNAOut.html" title="enum in compbio.data.sequence">RNAStructReader.RNAOut</a>[]</code></td>
182 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/data/sequence/RNAStructReader.RNAOut.html#values--">values</a></span>()</code>
183 <div class="block">Returns an array containing the constants of this enum type, in
184 the order they are declared.</div>
185 </td>
186 </tr>
187 </table>
188 <ul class="blockList">
189 <li class="blockList"><a name="methods.inherited.from.class.java.lang.Enum">
190 <!--   -->
191 </a>
192 <h3>Methods inherited from class&nbsp;java.lang.Enum</h3>
193 <code>clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf</code></li>
194 </ul>
195 <ul class="blockList">
196 <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
197 <!--   -->
198 </a>
199 <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
200 <code>getClass, notify, notifyAll, wait, wait, wait</code></li>
201 </ul>
202 </li>
203 </ul>
204 </li>
205 </ul>
206 </div>
207 <div class="details">
208 <ul class="blockList">
209 <li class="blockList">
210 <!-- ============ ENUM CONSTANT DETAIL =========== -->
211 <ul class="blockList">
212 <li class="blockList"><a name="enum.constant.detail">
213 <!--   -->
214 </a>
215 <h3>Enum Constant Detail</h3>
216 <a name="SEQ">
217 <!--   -->
218 </a>
219 <ul class="blockList">
220 <li class="blockList">
221 <h4>SEQ</h4>
222 <pre>public static final&nbsp;<a href="../../../compbio/data/sequence/RNAStructReader.RNAOut.html" title="enum in compbio.data.sequence">RNAStructReader.RNAOut</a> SEQ</pre>
223 </li>
224 </ul>
225 <a name="STRUCT">
226 <!--   -->
227 </a>
228 <ul class="blockList">
229 <li class="blockList">
230 <h4>STRUCT</h4>
231 <pre>public static final&nbsp;<a href="../../../compbio/data/sequence/RNAStructReader.RNAOut.html" title="enum in compbio.data.sequence">RNAStructReader.RNAOut</a> STRUCT</pre>
232 </li>
233 </ul>
234 <a name="ENERGY">
235 <!--   -->
236 </a>
237 <ul class="blockList">
238 <li class="blockList">
239 <h4>ENERGY</h4>
240 <pre>public static final&nbsp;<a href="../../../compbio/data/sequence/RNAStructReader.RNAOut.html" title="enum in compbio.data.sequence">RNAStructReader.RNAOut</a> ENERGY</pre>
241 </li>
242 </ul>
243 <a name="FREQ">
244 <!--   -->
245 </a>
246 <ul class="blockList">
247 <li class="blockList">
248 <h4>FREQ</h4>
249 <pre>public static final&nbsp;<a href="../../../compbio/data/sequence/RNAStructReader.RNAOut.html" title="enum in compbio.data.sequence">RNAStructReader.RNAOut</a> FREQ</pre>
250 </li>
251 </ul>
252 <a name="OTHER">
253 <!--   -->
254 </a>
255 <ul class="blockListLast">
256 <li class="blockList">
257 <h4>OTHER</h4>
258 <pre>public static final&nbsp;<a href="../../../compbio/data/sequence/RNAStructReader.RNAOut.html" title="enum in compbio.data.sequence">RNAStructReader.RNAOut</a> OTHER</pre>
259 </li>
260 </ul>
261 </li>
262 </ul>
263 <!-- ============ METHOD DETAIL ========== -->
264 <ul class="blockList">
265 <li class="blockList"><a name="method.detail">
266 <!--   -->
267 </a>
268 <h3>Method Detail</h3>
269 <a name="values--">
270 <!--   -->
271 </a>
272 <ul class="blockList">
273 <li class="blockList">
274 <h4>values</h4>
275 <pre>public static&nbsp;<a href="../../../compbio/data/sequence/RNAStructReader.RNAOut.html" title="enum in compbio.data.sequence">RNAStructReader.RNAOut</a>[]&nbsp;values()</pre>
276 <div class="block">Returns an array containing the constants of this enum type, in
277 the order they are declared.  This method may be used to iterate
278 over the constants as follows:
279 <pre>
280 for (RNAStructReader.RNAOut c : RNAStructReader.RNAOut.values())
281 &nbsp;   System.out.println(c);
282 </pre></div>
283 <dl>
284 <dt><span class="returnLabel">Returns:</span></dt>
285 <dd>an array containing the constants of this enum type, in the order they are declared</dd>
286 </dl>
287 </li>
288 </ul>
289 <a name="valueOf-java.lang.String-">
290 <!--   -->
291 </a>
292 <ul class="blockListLast">
293 <li class="blockList">
294 <h4>valueOf</h4>
295 <pre>public static&nbsp;<a href="../../../compbio/data/sequence/RNAStructReader.RNAOut.html" title="enum in compbio.data.sequence">RNAStructReader.RNAOut</a>&nbsp;valueOf(java.lang.String&nbsp;name)</pre>
296 <div class="block">Returns the enum constant of this type with the specified name.
297 The string must match <i>exactly</i> an identifier used to declare an
298 enum constant in this type.  (Extraneous whitespace characters are 
299 not permitted.)</div>
300 <dl>
301 <dt><span class="paramLabel">Parameters:</span></dt>
302 <dd><code>name</code> - the name of the enum constant to be returned.</dd>
303 <dt><span class="returnLabel">Returns:</span></dt>
304 <dd>the enum constant with the specified name</dd>
305 <dt><span class="throwsLabel">Throws:</span></dt>
306 <dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant with the specified name</dd>
307 <dd><code>java.lang.NullPointerException</code> - if the argument is null</dd>
308 </dl>
309 </li>
310 </ul>
311 </li>
312 </ul>
313 </li>
314 </ul>
315 </div>
316 </div>
317 <!-- ========= END OF CLASS DATA ========= -->
318 <!-- ======= START OF BOTTOM NAVBAR ====== -->
319 <div class="bottomNav"><a name="navbar.bottom">
320 <!--   -->
321 </a>
322 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
323 <a name="navbar.bottom.firstrow">
324 <!--   -->
325 </a>
326 <ul class="navList" title="Navigation">
327 <li><a href="../../../overview-summary.html">Overview</a></li>
328 <li><a href="package-summary.html">Package</a></li>
329 <li class="navBarCell1Rev">Class</li>
330 <li><a href="class-use/RNAStructReader.RNAOut.html">Use</a></li>
331 <li><a href="package-tree.html">Tree</a></li>
332 <li><a href="../../../deprecated-list.html">Deprecated</a></li>
333 <li><a href="../../../index-files/index-1.html">Index</a></li>
334 <li><a href="../../../help-doc.html">Help</a></li>
335 </ul>
336 </div>
337 <div class="subNav">
338 <ul class="navList">
339 <li><a href="../../../compbio/data/sequence/RNAStructReader.AlifoldResult.html" title="enum in compbio.data.sequence"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
340 <li><a href="../../../compbio/data/sequence/RNAStructScoreManager.html" title="class in compbio.data.sequence"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
341 </ul>
342 <ul class="navList">
343 <li><a href="../../../index.html?compbio/data/sequence/RNAStructReader.RNAOut.html" target="_top">Frames</a></li>
344 <li><a href="RNAStructReader.RNAOut.html" target="_top">No&nbsp;Frames</a></li>
345 </ul>
346 <ul class="navList" id="allclasses_navbar_bottom">
347 <li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
348 </ul>
349 <div>
350 <script type="text/javascript"><!--
351   allClassesLink = document.getElementById("allclasses_navbar_bottom");
352   if(window==top) {
353     allClassesLink.style.display = "block";
354   }
355   else {
356     allClassesLink.style.display = "none";
357   }
358   //-->
359 </script>
360 </div>
361 <div>
362 <ul class="subNavList">
363 <li>Summary:&nbsp;</li>
364 <li>Nested&nbsp;|&nbsp;</li>
365 <li><a href="#enum.constant.summary">Enum Constants</a>&nbsp;|&nbsp;</li>
366 <li>Field&nbsp;|&nbsp;</li>
367 <li><a href="#method.summary">Method</a></li>
368 </ul>
369 <ul class="subNavList">
370 <li>Detail:&nbsp;</li>
371 <li><a href="#enum.constant.detail">Enum Constants</a>&nbsp;|&nbsp;</li>
372 <li>Field&nbsp;|&nbsp;</li>
373 <li><a href="#method.detail">Method</a></li>
374 </ul>
375 </div>
376 <a name="skip.navbar.bottom">
377 <!--   -->
378 </a></div>
379 <!-- ======== END OF BOTTOM NAVBAR ======= -->
380 </body>
381 </html>