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