Re-formatting the file
[jabaws.git] / website / full_javadoc / compbio / engine / FilePuller.html
index 5a017ae..8f9d285 100644 (file)
@@ -2,12 +2,12 @@
 <!--NewPage-->\r
 <HTML>\r
 <HEAD>\r
-<!-- Generated by javadoc (build 1.6.0_14) on Wed Feb 17 16:46:49 GMT 2010 -->\r
+<!-- Generated by javadoc (build 1.6.0_24) on Wed Dec 07 12:30:41 GMT 2011 -->\r
 <TITLE>\r
 FilePuller\r
 </TITLE>\r
 \r
-<META NAME="date" CONTENT="2010-02-17">\r
+<META NAME="date" CONTENT="2011-12-07">\r
 \r
 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">\r
 \r
@@ -92,15 +92,15 @@ compbio.engine</FONT>
 <BR>\r
 Class FilePuller</H2>\r
 <PRE>\r
-java.lang.Object\r
+<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
   <IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>compbio.engine.FilePuller</B>\r
 </PRE>\r
 <DL>\r
-<DT><B>All Implemented Interfaces:</B> <DD>java.lang.Comparable&lt;java.util.concurrent.Delayed&gt;, java.util.concurrent.Delayed</DD>\r
+<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
 </DL>\r
 <HR>\r
 <DL>\r
-<DT><PRE>public class <B>FilePuller</B><DT>extends java.lang.Object<DT>implements java.util.concurrent.Delayed</DL>\r
+<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
 </PRE>\r
 \r
 <P>\r
@@ -119,7 +119,7 @@ java.lang.Object
 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 <CODE>&nbsp;int</CODE></FONT></TD>\r
-<TD><CODE><B><A HREF="../../compbio/engine/FilePuller.html#compareTo(java.util.concurrent.Delayed)">compareTo</A></B>(java.util.concurrent.Delayed&nbsp;o)</CODE>\r
+<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
 \r
 <BR>\r
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
@@ -135,7 +135,7 @@ java.lang.Object
 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 <CODE>&nbsp;boolean</CODE></FONT></TD>\r
-<TD><CODE><B><A HREF="../../compbio/engine/FilePuller.html#equals(java.lang.Object)">equals</A></B>(java.lang.Object&nbsp;obj)</CODE>\r
+<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
 \r
 <BR>\r
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
@@ -143,14 +143,14 @@ java.lang.Object
 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 <CODE>&nbsp;long</CODE></FONT></TD>\r
-<TD><CODE><B><A HREF="../../compbio/engine/FilePuller.html#getDelay(java.util.concurrent.TimeUnit)">getDelay</A></B>(java.util.concurrent.TimeUnit&nbsp;unit)</CODE>\r
+<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
 \r
 <BR>\r
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
 </TR>\r
 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
-<CODE>&nbsp;java.lang.String</CODE></FONT></TD>\r
+<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
 <TD><CODE><B><A HREF="../../compbio/engine/FilePuller.html#getFile()">getFile</A></B>()</CODE>\r
 \r
 <BR>\r
@@ -199,7 +199,7 @@ java.lang.Object
 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 <CODE>static&nbsp;<A HREF="../../compbio/engine/FilePuller.html" title="class in compbio.engine">FilePuller</A></CODE></FONT></TD>\r
-<TD><CODE><B><A HREF="../../compbio/engine/FilePuller.html#newFilePuller(java.lang.String, int)">newFilePuller</A></B>(java.lang.String&nbsp;file,\r
+<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
               int&nbsp;chunkSize)</CODE>\r
 \r
 <BR>\r
@@ -208,7 +208,7 @@ java.lang.Object
 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 <CODE>static&nbsp;<A HREF="../../compbio/engine/FilePuller.html" title="class in compbio.engine">FilePuller</A></CODE></FONT></TD>\r
-<TD><CODE><B><A HREF="../../compbio/engine/FilePuller.html#newProgressPuller(java.lang.String)">newProgressPuller</A></B>(java.lang.String&nbsp;file)</CODE>\r
+<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
 \r
 <BR>\r
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Progress Puller is designed to read 3 characters from the beginning of
@@ -224,7 +224,7 @@ java.lang.Object
 </TR>\r
 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
-<CODE>&nbsp;java.lang.String</CODE></FONT></TD>\r
+<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
 <TD><CODE><B><A HREF="../../compbio/engine/FilePuller.html#toString()">toString</A></B>()</CODE>\r
 \r
 <BR>\r
@@ -242,10 +242,10 @@ java.lang.Object
 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>\r
 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
-<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>\r
+<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
 </TR>\r
 <TR BGCOLOR="white" CLASS="TableRowColor">\r
-<TD><CODE>getClass, notify, notifyAll, wait, wait, wait</CODE></TD>\r
+<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
 </TR>\r
 </TABLE>\r
 &nbsp;\r
@@ -264,7 +264,7 @@ java.lang.Object
 <A NAME="newFilePuller(java.lang.String, int)"><!-- --></A><H3>\r
 newFilePuller</H3>\r
 <PRE>\r
-public static <A HREF="../../compbio/engine/FilePuller.html" title="class in compbio.engine">FilePuller</A> <B>newFilePuller</B>(java.lang.String&nbsp;file,\r
+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
                                        int&nbsp;chunkSize)</PRE>\r
 <DL>\r
 <DD><DL>\r
@@ -279,7 +279,7 @@ public static <A HREF="../../compbio/engine/FilePuller.html" title="class in com
 <A NAME="newProgressPuller(java.lang.String)"><!-- --></A><H3>\r
 newProgressPuller</H3>\r
 <PRE>\r
-public static <A HREF="../../compbio/engine/FilePuller.html" title="class in compbio.engine">FilePuller</A> <B>newProgressPuller</B>(java.lang.String&nbsp;file)</PRE>\r
+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
 <DL>\r
 <DD>Progress Puller is designed to read 3 characters from the beginning of
  the file, nothing more. Intended to be used in conjunction with a tool
@@ -291,7 +291,7 @@ public static <A HREF="../../compbio/engine/FilePuller.html" title="class in com
 </DD>\r
 <DD><DL>\r
 <DT><B>Parameters:</B><DD><CODE>file</CODE> - \r
-<DT><B>Returns:</B><DD></DL>\r
+<DT><B>Returns:</B><DD>instance</DL>\r
 </DD>\r
 </DL>\r
 <HR>\r
@@ -300,7 +300,7 @@ public static <A HREF="../../compbio/engine/FilePuller.html" title="class in com
 pull</H3>\r
 <PRE>\r
 public <A HREF="../../compbio/metadata/ChunkHolder.html" title="class in compbio.metadata">ChunkHolder</A> <B>pull</B>(long&nbsp;position)\r
-                 throws java.io.IOException</PRE>\r
+                 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
 <DL>\r
 <DD><DL>\r
 </DL>\r
@@ -308,7 +308,7 @@ public <A HREF="../../compbio/metadata/ChunkHolder.html" title="class in compbio
 <DD><DL>\r
 \r
 <DT><B>Throws:</B>\r
-<DD><CODE>java.io.IOException</CODE></DL>\r
+<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
 </DD>\r
 </DL>\r
 <HR>\r
@@ -330,7 +330,7 @@ public void <B>initPull</B>()</PRE>
 <A NAME="getFile()"><!-- --></A><H3>\r
 getFile</H3>\r
 <PRE>\r
-public java.lang.String <B>getFile</B>()</PRE>\r
+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
 <DL>\r
 <DD><DL>\r
 </DL>\r
@@ -373,7 +373,7 @@ public void <B>waitForFile</B>(long&nbsp;maxWaitSeconds)</PRE>
 hasMoreData</H3>\r
 <PRE>\r
 public boolean <B>hasMoreData</B>()\r
-                    throws java.io.IOException</PRE>\r
+                    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
 <DL>\r
 <DD><DL>\r
 </DL>\r
@@ -381,7 +381,7 @@ public boolean <B>hasMoreData</B>()
 <DD><DL>\r
 \r
 <DT><B>Throws:</B>\r
-<DD><CODE>java.io.IOException</CODE></DL>\r
+<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
 </DD>\r
 </DL>\r
 <HR>\r
@@ -389,10 +389,10 @@ public boolean <B>hasMoreData</B>()
 <A NAME="compareTo(java.util.concurrent.Delayed)"><!-- --></A><H3>\r
 compareTo</H3>\r
 <PRE>\r
-public int <B>compareTo</B>(java.util.concurrent.Delayed&nbsp;o)</PRE>\r
+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
 <DL>\r
 <DD><DL>\r
-<DT><B>Specified by:</B><DD><CODE>compareTo</CODE> in interface <CODE>java.lang.Comparable&lt;java.util.concurrent.Delayed&gt;</CODE></DL>\r
+<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
 </DD>\r
 <DD><DL>\r
 </DL>\r
@@ -403,10 +403,10 @@ public int <B>compareTo</B>(java.util.concurrent.Delayed&nbsp;o)</PRE>
 <A NAME="getDelay(java.util.concurrent.TimeUnit)"><!-- --></A><H3>\r
 getDelay</H3>\r
 <PRE>\r
-public long <B>getDelay</B>(java.util.concurrent.TimeUnit&nbsp;unit)</PRE>\r
+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
 <DL>\r
 <DD><DL>\r
-<DT><B>Specified by:</B><DD><CODE>getDelay</CODE> in interface <CODE>java.util.concurrent.Delayed</CODE></DL>\r
+<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
 </DD>\r
 <DD><DL>\r
 </DL>\r
@@ -431,10 +431,10 @@ public void <B>disconnect</B>()</PRE>
 <A NAME="toString()"><!-- --></A><H3>\r
 toString</H3>\r
 <PRE>\r
-public java.lang.String <B>toString</B>()</PRE>\r
+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
 <DL>\r
 <DD><DL>\r
-<DT><B>Overrides:</B><DD><CODE>toString</CODE> in class <CODE>java.lang.Object</CODE></DL>\r
+<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
 </DD>\r
 <DD><DL>\r
 </DL>\r
@@ -445,10 +445,10 @@ public java.lang.String <B>toString</B>()</PRE>
 <A NAME="equals(java.lang.Object)"><!-- --></A><H3>\r
 equals</H3>\r
 <PRE>\r
-public boolean <B>equals</B>(java.lang.Object&nbsp;obj)</PRE>\r
+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
 <DL>\r
 <DD><DL>\r
-<DT><B>Overrides:</B><DD><CODE>equals</CODE> in class <CODE>java.lang.Object</CODE></DL>\r
+<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
 </DD>\r
 <DD><DL>\r
 </DL>\r
@@ -462,7 +462,7 @@ hashCode</H3>
 public int <B>hashCode</B>()</PRE>\r
 <DL>\r
 <DD><DL>\r
-<DT><B>Overrides:</B><DD><CODE>hashCode</CODE> in class <CODE>java.lang.Object</CODE></DL>\r
+<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
 </DD>\r
 <DD><DL>\r
 </DL>\r
@@ -474,7 +474,7 @@ public int <B>hashCode</B>()</PRE>
 getProgress</H3>\r
 <PRE>\r
 public byte <B>getProgress</B>()\r
-                 throws java.io.IOException</PRE>\r
+                 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
 <DL>\r
 <DD><DL>\r
 </DL>\r
@@ -482,7 +482,7 @@ public byte <B>getProgress</B>()
 <DD><DL>\r
 \r
 <DT><B>Throws:</B>\r
-<DD><CODE>java.io.IOException</CODE></DL>\r
+<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
 </DD>\r
 </DL>\r
 <!-- ========= END OF CLASS DATA ========= -->\r