updated javadoc
[jabaws.git] / website / full_javadoc / compbio / engine / FilePuller.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">\r
2 <!--NewPage-->\r
3 <HTML>\r
4 <HEAD>\r
5 <!-- Generated by javadoc (build 1.6.0_24) on Fri Aug 12 14:32:35 BST 2011 -->\r
6 <TITLE>\r
7 FilePuller\r
8 </TITLE>\r
9 \r
10 <META NAME="date" CONTENT="2011-08-12">\r
11 \r
12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">\r
13 \r
14 <SCRIPT type="text/javascript">\r
15 function windowTitle()\r
16 {\r
17     if (location.href.indexOf('is-external=true') == -1) {\r
18         parent.document.title="FilePuller";\r
19     }\r
20 }\r
21 </SCRIPT>\r
22 <NOSCRIPT>\r
23 </NOSCRIPT>\r
24 \r
25 </HEAD>\r
26 \r
27 <BODY BGCOLOR="white" onload="windowTitle();">\r
28 <HR>\r
29 \r
30 \r
31 <!-- ========= START OF TOP NAVBAR ======= -->\r
32 <A NAME="navbar_top"><!-- --></A>\r
33 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>\r
34 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
35 <TR>\r
36 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
37 <A NAME="navbar_top_firstrow"><!-- --></A>\r
38 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
39   <TR ALIGN="center" VALIGN="top">\r
40   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
41   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
42   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
43   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/FilePuller.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
44   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
45   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
46   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
47   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
48   </TR>\r
49 </TABLE>\r
50 </TD>\r
51 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
52 </EM>\r
53 </TD>\r
54 </TR>\r
55 \r
56 <TR>\r
57 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
58 &nbsp;<A HREF="../../compbio/engine/Configurator.html" title="class in compbio.engine"><B>PREV CLASS</B></A>&nbsp;\r
59 &nbsp;<A HREF="../../compbio/engine/Job.html" title="class in compbio.engine"><B>NEXT CLASS</B></A></FONT></TD>\r
60 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
61   <A HREF="../../index.html?compbio/engine/FilePuller.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
62 &nbsp;<A HREF="FilePuller.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
63 &nbsp;<SCRIPT type="text/javascript">\r
64   <!--\r
65   if(window==top) {\r
66     document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');\r
67   }\r
68   //-->\r
69 </SCRIPT>\r
70 <NOSCRIPT>\r
71   <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>\r
72 </NOSCRIPT>\r
73 \r
74 \r
75 </FONT></TD>\r
76 </TR>\r
77 <TR>\r
78 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
79   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
80 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
81 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
82 </TR>\r
83 </TABLE>\r
84 <A NAME="skip-navbar_top"></A>\r
85 <!-- ========= END OF TOP NAVBAR ========= -->\r
86 \r
87 <HR>\r
88 <!-- ======== START OF CLASS DATA ======== -->\r
89 <H2>\r
90 <FONT SIZE="-1">\r
91 compbio.engine</FONT>\r
92 <BR>\r
93 Class FilePuller</H2>\r
94 <PRE>\r
95 <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>\r
96   <IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>compbio.engine.FilePuller</B>\r
97 </PRE>\r
98 <DL>\r
99 <DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</A>&lt;<A HREF="http://java.sun.com/javase/6/docs/api/java/util/concurrent/Delayed.html?is-external=true" title="class or interface in java.util.concurrent">Delayed</A>&gt;, <A HREF="http://java.sun.com/javase/6/docs/api/java/util/concurrent/Delayed.html?is-external=true" title="class or interface in java.util.concurrent">Delayed</A></DD>\r
100 </DL>\r
101 <HR>\r
102 <DL>\r
103 <DT><PRE>public class <B>FilePuller</B><DT>extends <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A><DT>implements <A HREF="http://java.sun.com/javase/6/docs/api/java/util/concurrent/Delayed.html?is-external=true" title="class or interface in java.util.concurrent">Delayed</A></DL>\r
104 </PRE>\r
105 \r
106 <P>\r
107 <HR>\r
108 \r
109 <P>\r
110 \r
111 <!-- ========== METHOD SUMMARY =========== -->\r
112 \r
113 <A NAME="method_summary"><!-- --></A>\r
114 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
115 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
116 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
117 <B>Method Summary</B></FONT></TH>\r
118 </TR>\r
119 <TR BGCOLOR="white" CLASS="TableRowColor">\r
120 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
121 <CODE>&nbsp;int</CODE></FONT></TD>\r
122 <TD><CODE><B><A HREF="../../compbio/engine/FilePuller.html#compareTo(java.util.concurrent.Delayed)">compareTo</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/util/concurrent/Delayed.html?is-external=true" title="class or interface in java.util.concurrent">Delayed</A>&nbsp;o)</CODE>\r
123 \r
124 <BR>\r
125 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
126 </TR>\r
127 <TR BGCOLOR="white" CLASS="TableRowColor">\r
128 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
129 <CODE>&nbsp;void</CODE></FONT></TD>\r
130 <TD><CODE><B><A HREF="../../compbio/engine/FilePuller.html#disconnect()">disconnect</A></B>()</CODE>\r
131 \r
132 <BR>\r
133 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
134 </TR>\r
135 <TR BGCOLOR="white" CLASS="TableRowColor">\r
136 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
137 <CODE>&nbsp;boolean</CODE></FONT></TD>\r
138 <TD><CODE><B><A HREF="../../compbio/engine/FilePuller.html#equals(java.lang.Object)">equals</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>&nbsp;obj)</CODE>\r
139 \r
140 <BR>\r
141 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
142 </TR>\r
143 <TR BGCOLOR="white" CLASS="TableRowColor">\r
144 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
145 <CODE>&nbsp;long</CODE></FONT></TD>\r
146 <TD><CODE><B><A HREF="../../compbio/engine/FilePuller.html#getDelay(java.util.concurrent.TimeUnit)">getDelay</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</A>&nbsp;unit)</CODE>\r
147 \r
148 <BR>\r
149 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
150 </TR>\r
151 <TR BGCOLOR="white" CLASS="TableRowColor">\r
152 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
153 <CODE>&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>\r
154 <TD><CODE><B><A HREF="../../compbio/engine/FilePuller.html#getFile()">getFile</A></B>()</CODE>\r
155 \r
156 <BR>\r
157 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
158 </TR>\r
159 <TR BGCOLOR="white" CLASS="TableRowColor">\r
160 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
161 <CODE>&nbsp;byte</CODE></FONT></TD>\r
162 <TD><CODE><B><A HREF="../../compbio/engine/FilePuller.html#getProgress()">getProgress</A></B>()</CODE>\r
163 \r
164 <BR>\r
165 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
166 </TR>\r
167 <TR BGCOLOR="white" CLASS="TableRowColor">\r
168 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
169 <CODE>&nbsp;int</CODE></FONT></TD>\r
170 <TD><CODE><B><A HREF="../../compbio/engine/FilePuller.html#hashCode()">hashCode</A></B>()</CODE>\r
171 \r
172 <BR>\r
173 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
174 </TR>\r
175 <TR BGCOLOR="white" CLASS="TableRowColor">\r
176 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
177 <CODE>&nbsp;boolean</CODE></FONT></TD>\r
178 <TD><CODE><B><A HREF="../../compbio/engine/FilePuller.html#hasMoreData()">hasMoreData</A></B>()</CODE>\r
179 \r
180 <BR>\r
181 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
182 </TR>\r
183 <TR BGCOLOR="white" CLASS="TableRowColor">\r
184 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
185 <CODE>&nbsp;void</CODE></FONT></TD>\r
186 <TD><CODE><B><A HREF="../../compbio/engine/FilePuller.html#initPull()">initPull</A></B>()</CODE>\r
187 \r
188 <BR>\r
189 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
190 </TR>\r
191 <TR BGCOLOR="white" CLASS="TableRowColor">\r
192 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
193 <CODE>&nbsp;boolean</CODE></FONT></TD>\r
194 <TD><CODE><B><A HREF="../../compbio/engine/FilePuller.html#isFileCreated()">isFileCreated</A></B>()</CODE>\r
195 \r
196 <BR>\r
197 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
198 </TR>\r
199 <TR BGCOLOR="white" CLASS="TableRowColor">\r
200 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
201 <CODE>static&nbsp;<A HREF="../../compbio/engine/FilePuller.html" title="class in compbio.engine">FilePuller</A></CODE></FONT></TD>\r
202 <TD><CODE><B><A HREF="../../compbio/engine/FilePuller.html#newFilePuller(java.lang.String, int)">newFilePuller</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;file,\r
203               int&nbsp;chunkSize)</CODE>\r
204 \r
205 <BR>\r
206 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
207 </TR>\r
208 <TR BGCOLOR="white" CLASS="TableRowColor">\r
209 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
210 <CODE>static&nbsp;<A HREF="../../compbio/engine/FilePuller.html" title="class in compbio.engine">FilePuller</A></CODE></FONT></TD>\r
211 <TD><CODE><B><A HREF="../../compbio/engine/FilePuller.html#newProgressPuller(java.lang.String)">newProgressPuller</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;file)</CODE>\r
212 \r
213 <BR>\r
214 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Progress Puller is designed to read 3 characters from the beginning of
215  the file, nothing more.</TD>\r
216 </TR>\r
217 <TR BGCOLOR="white" CLASS="TableRowColor">\r
218 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
219 <CODE>&nbsp;<A HREF="../../compbio/metadata/ChunkHolder.html" title="class in compbio.metadata">ChunkHolder</A></CODE></FONT></TD>\r
220 <TD><CODE><B><A HREF="../../compbio/engine/FilePuller.html#pull(long)">pull</A></B>(long&nbsp;position)</CODE>\r
221 \r
222 <BR>\r
223 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
224 </TR>\r
225 <TR BGCOLOR="white" CLASS="TableRowColor">\r
226 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
227 <CODE>&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>\r
228 <TD><CODE><B><A HREF="../../compbio/engine/FilePuller.html#toString()">toString</A></B>()</CODE>\r
229 \r
230 <BR>\r
231 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
232 </TR>\r
233 <TR BGCOLOR="white" CLASS="TableRowColor">\r
234 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
235 <CODE>&nbsp;void</CODE></FONT></TD>\r
236 <TD><CODE><B><A HREF="../../compbio/engine/FilePuller.html#waitForFile(long)">waitForFile</A></B>(long&nbsp;maxWaitSeconds)</CODE>\r
237 \r
238 <BR>\r
239 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
240 </TR>\r
241 </TABLE>\r
242 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>\r
243 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
244 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
245 <TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>\r
246 </TR>\r
247 <TR BGCOLOR="white" CLASS="TableRowColor">\r
248 <TD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>\r
249 </TR>\r
250 </TABLE>\r
251 &nbsp;\r
252 <P>\r
253 \r
254 <!-- ============ METHOD DETAIL ========== -->\r
255 \r
256 <A NAME="method_detail"><!-- --></A>\r
257 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
258 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
259 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
260 <B>Method Detail</B></FONT></TH>\r
261 </TR>\r
262 </TABLE>\r
263 \r
264 <A NAME="newFilePuller(java.lang.String, int)"><!-- --></A><H3>\r
265 newFilePuller</H3>\r
266 <PRE>\r
267 public static <A HREF="../../compbio/engine/FilePuller.html" title="class in compbio.engine">FilePuller</A> <B>newFilePuller</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;file,\r
268                                        int&nbsp;chunkSize)</PRE>\r
269 <DL>\r
270 <DD><DL>\r
271 </DL>\r
272 </DD>\r
273 <DD><DL>\r
274 </DL>\r
275 </DD>\r
276 </DL>\r
277 <HR>\r
278 \r
279 <A NAME="newProgressPuller(java.lang.String)"><!-- --></A><H3>\r
280 newProgressPuller</H3>\r
281 <PRE>\r
282 public static <A HREF="../../compbio/engine/FilePuller.html" title="class in compbio.engine">FilePuller</A> <B>newProgressPuller</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;file)</PRE>\r
283 <DL>\r
284 <DD>Progress Puller is designed to read 3 characters from the beginning of
285  the file, nothing more. Intended to be used in conjunction with a tool
286  which output progress as a percent value from 0 to 100. In any cases
287  progress could not be more than the largest byte value 255.\r
288 <P>\r
289 <DD><DL>\r
290 </DL>\r
291 </DD>\r
292 <DD><DL>\r
293 <DT><B>Parameters:</B><DD><CODE>file</CODE> - \r
294 <DT><B>Returns:</B><DD>instance</DL>\r
295 </DD>\r
296 </DL>\r
297 <HR>\r
298 \r
299 <A NAME="pull(long)"><!-- --></A><H3>\r
300 pull</H3>\r
301 <PRE>\r
302 public <A HREF="../../compbio/metadata/ChunkHolder.html" title="class in compbio.metadata">ChunkHolder</A> <B>pull</B>(long&nbsp;position)\r
303                  throws <A HREF="http://java.sun.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE>\r
304 <DL>\r
305 <DD><DL>\r
306 </DL>\r
307 </DD>\r
308 <DD><DL>\r
309 \r
310 <DT><B>Throws:</B>\r
311 <DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE></DL>\r
312 </DD>\r
313 </DL>\r
314 <HR>\r
315 \r
316 <A NAME="initPull()"><!-- --></A><H3>\r
317 initPull</H3>\r
318 <PRE>\r
319 public void <B>initPull</B>()</PRE>\r
320 <DL>\r
321 <DD><DL>\r
322 </DL>\r
323 </DD>\r
324 <DD><DL>\r
325 </DL>\r
326 </DD>\r
327 </DL>\r
328 <HR>\r
329 \r
330 <A NAME="getFile()"><!-- --></A><H3>\r
331 getFile</H3>\r
332 <PRE>\r
333 public <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getFile</B>()</PRE>\r
334 <DL>\r
335 <DD><DL>\r
336 </DL>\r
337 </DD>\r
338 <DD><DL>\r
339 </DL>\r
340 </DD>\r
341 </DL>\r
342 <HR>\r
343 \r
344 <A NAME="isFileCreated()"><!-- --></A><H3>\r
345 isFileCreated</H3>\r
346 <PRE>\r
347 public boolean <B>isFileCreated</B>()</PRE>\r
348 <DL>\r
349 <DD><DL>\r
350 </DL>\r
351 </DD>\r
352 <DD><DL>\r
353 </DL>\r
354 </DD>\r
355 </DL>\r
356 <HR>\r
357 \r
358 <A NAME="waitForFile(long)"><!-- --></A><H3>\r
359 waitForFile</H3>\r
360 <PRE>\r
361 public void <B>waitForFile</B>(long&nbsp;maxWaitSeconds)</PRE>\r
362 <DL>\r
363 <DD><DL>\r
364 </DL>\r
365 </DD>\r
366 <DD><DL>\r
367 </DL>\r
368 </DD>\r
369 </DL>\r
370 <HR>\r
371 \r
372 <A NAME="hasMoreData()"><!-- --></A><H3>\r
373 hasMoreData</H3>\r
374 <PRE>\r
375 public boolean <B>hasMoreData</B>()\r
376                     throws <A HREF="http://java.sun.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE>\r
377 <DL>\r
378 <DD><DL>\r
379 </DL>\r
380 </DD>\r
381 <DD><DL>\r
382 \r
383 <DT><B>Throws:</B>\r
384 <DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE></DL>\r
385 </DD>\r
386 </DL>\r
387 <HR>\r
388 \r
389 <A NAME="compareTo(java.util.concurrent.Delayed)"><!-- --></A><H3>\r
390 compareTo</H3>\r
391 <PRE>\r
392 public int <B>compareTo</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/util/concurrent/Delayed.html?is-external=true" title="class or interface in java.util.concurrent">Delayed</A>&nbsp;o)</PRE>\r
393 <DL>\r
394 <DD><DL>\r
395 <DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Comparable.html?is-external=true#compareTo(T)" title="class or interface in java.lang">compareTo</A></CODE> in interface <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</A>&lt;<A HREF="http://java.sun.com/javase/6/docs/api/java/util/concurrent/Delayed.html?is-external=true" title="class or interface in java.util.concurrent">Delayed</A>&gt;</CODE></DL>\r
396 </DD>\r
397 <DD><DL>\r
398 </DL>\r
399 </DD>\r
400 </DL>\r
401 <HR>\r
402 \r
403 <A NAME="getDelay(java.util.concurrent.TimeUnit)"><!-- --></A><H3>\r
404 getDelay</H3>\r
405 <PRE>\r
406 public long <B>getDelay</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</A>&nbsp;unit)</PRE>\r
407 <DL>\r
408 <DD><DL>\r
409 <DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/concurrent/Delayed.html?is-external=true#getDelay(java.util.concurrent.TimeUnit)" title="class or interface in java.util.concurrent">getDelay</A></CODE> in interface <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/concurrent/Delayed.html?is-external=true" title="class or interface in java.util.concurrent">Delayed</A></CODE></DL>\r
410 </DD>\r
411 <DD><DL>\r
412 </DL>\r
413 </DD>\r
414 </DL>\r
415 <HR>\r
416 \r
417 <A NAME="disconnect()"><!-- --></A><H3>\r
418 disconnect</H3>\r
419 <PRE>\r
420 public void <B>disconnect</B>()</PRE>\r
421 <DL>\r
422 <DD><DL>\r
423 </DL>\r
424 </DD>\r
425 <DD><DL>\r
426 </DL>\r
427 </DD>\r
428 </DL>\r
429 <HR>\r
430 \r
431 <A NAME="toString()"><!-- --></A><H3>\r
432 toString</H3>\r
433 <PRE>\r
434 public <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>toString</B>()</PRE>\r
435 <DL>\r
436 <DD><DL>\r
437 <DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A></CODE> in class <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></DL>\r
438 </DD>\r
439 <DD><DL>\r
440 </DL>\r
441 </DD>\r
442 </DL>\r
443 <HR>\r
444 \r
445 <A NAME="equals(java.lang.Object)"><!-- --></A><H3>\r
446 equals</H3>\r
447 <PRE>\r
448 public boolean <B>equals</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>&nbsp;obj)</PRE>\r
449 <DL>\r
450 <DD><DL>\r
451 <DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A></CODE> in class <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></DL>\r
452 </DD>\r
453 <DD><DL>\r
454 </DL>\r
455 </DD>\r
456 </DL>\r
457 <HR>\r
458 \r
459 <A NAME="hashCode()"><!-- --></A><H3>\r
460 hashCode</H3>\r
461 <PRE>\r
462 public int <B>hashCode</B>()</PRE>\r
463 <DL>\r
464 <DD><DL>\r
465 <DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A></CODE> in class <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></DL>\r
466 </DD>\r
467 <DD><DL>\r
468 </DL>\r
469 </DD>\r
470 </DL>\r
471 <HR>\r
472 \r
473 <A NAME="getProgress()"><!-- --></A><H3>\r
474 getProgress</H3>\r
475 <PRE>\r
476 public byte <B>getProgress</B>()\r
477                  throws <A HREF="http://java.sun.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE>\r
478 <DL>\r
479 <DD><DL>\r
480 </DL>\r
481 </DD>\r
482 <DD><DL>\r
483 \r
484 <DT><B>Throws:</B>\r
485 <DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE></DL>\r
486 </DD>\r
487 </DL>\r
488 <!-- ========= END OF CLASS DATA ========= -->\r
489 <HR>\r
490 \r
491 \r
492 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
493 <A NAME="navbar_bottom"><!-- --></A>\r
494 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>\r
495 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
496 <TR>\r
497 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
498 <A NAME="navbar_bottom_firstrow"><!-- --></A>\r
499 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
500   <TR ALIGN="center" VALIGN="top">\r
501   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
502   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
503   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
504   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/FilePuller.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
505   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
506   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
507   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
508   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
509   </TR>\r
510 </TABLE>\r
511 </TD>\r
512 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
513 </EM>\r
514 </TD>\r
515 </TR>\r
516 \r
517 <TR>\r
518 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
519 &nbsp;<A HREF="../../compbio/engine/Configurator.html" title="class in compbio.engine"><B>PREV CLASS</B></A>&nbsp;\r
520 &nbsp;<A HREF="../../compbio/engine/Job.html" title="class in compbio.engine"><B>NEXT CLASS</B></A></FONT></TD>\r
521 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
522   <A HREF="../../index.html?compbio/engine/FilePuller.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
523 &nbsp;<A HREF="FilePuller.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
524 &nbsp;<SCRIPT type="text/javascript">\r
525   <!--\r
526   if(window==top) {\r
527     document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');\r
528   }\r
529   //-->\r
530 </SCRIPT>\r
531 <NOSCRIPT>\r
532   <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>\r
533 </NOSCRIPT>\r
534 \r
535 \r
536 </FONT></TD>\r
537 </TR>\r
538 <TR>\r
539 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
540   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
541 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
542 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
543 </TR>\r
544 </TABLE>\r
545 <A NAME="skip-navbar_bottom"></A>\r
546 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
547 \r
548 <HR>\r
549 \r
550 </BODY>\r
551 </HTML>\r