updated javadoc
[jabaws.git] / website / full_javadoc / compbio / data / sequence / FastaReader.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:34 BST 2011 -->\r
6 <TITLE>\r
7 FastaReader\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="FastaReader";\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/FastaReader.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/data/sequence/DisorderMethod.html" title="enum in compbio.data.sequence"><B>PREV CLASS</B></A>&nbsp;\r
59 &nbsp;<A HREF="../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence"><B>NEXT CLASS</B></A></FONT></TD>\r
60 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
61   <A HREF="../../../index.html?compbio/data/sequence/FastaReader.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
62 &nbsp;<A HREF="FastaReader.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;<A HREF="#constructor_summary">CONSTR</A>&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;<A HREF="#constructor_detail">CONSTR</A>&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.data.sequence</FONT>\r
92 <BR>\r
93 Class FastaReader</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.data.sequence.FastaReader</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/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</A>&lt;<A HREF="../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</A>&gt;</DD>\r
100 </DL>\r
101 <HR>\r
102 <DL>\r
103 <DT><PRE>public class <B>FastaReader</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/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</A>&lt;<A HREF="../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</A>&gt;</DL>\r
104 </PRE>\r
105 \r
106 <P>\r
107 Reads files with FASTA formatted sequences. All the information in the FASTA
108  header is preserved including trailing white spaces. All the white spaces are
109  removed from the sequence.
110  
111  Examples of the correct input:
112  
113  <pre>
114  
115  >zedpshvyzg
116  GCQDKNNIAELNEIMGTTRSPSDWQHMKGASPRAEIGLTGKKDSWWRHCCSKEFNKTPPPIHPDMKRWGWMWNRENFEKFLIDNFLNPPCPRLMLTKGTWWRHEDLCHEIFWSTLRWLCLGNQSFSAMIWGHLCECHRMIWWESNEHMFWLKFRRALKKMNSNGPCMGPDNREWMITNRMGKEFCGPAFAGDCQSCWRKCHKTNKICFNEKKGTPTKIDHEQKDIMDILKDIDNHRNWKQCQLWLLTSKSTDQESTTMLTWSTWRDFFIIIKQPFDHKCRGALDANGDFQIAAELKWPAPMIILRQNQKTMHDKSCHHFFTNRCPLMHTTRANDKQCSWHTRKQFICQQDFTTWQHRPDTHRILPSWCMSTRRKNHIKNTPALAFSTCEMGDLPNGWAPGTIILQRQFTQAIKLPQETTGWPRCDPKFDHWNMSKWLRQLLGRDDEMIPPQCD
117  
118  >xovkactesa
119  CPLSKWWNRRAFLSHTANHWMILMTWEGPHDGESKMRIAMMKWSPCKPTMSHFRCGLDAWAEPIRQIACESTFRM
120  FCTTPRPIHKLTEMWGHMNGWTGAFCRQLECEWMMPPRHPHPCTSTFNNNKKRLIGQIPNEGKQLFINFQKPQHG
121  FSESDIWIWKDNPTAWHEGLTIAGIGDGQHCWNWMPMPWSGAPTSNALIEFWTWLGMIGTRCKTQGMWWDAMNHH
122  DQFELSANAHIAAHHMEKKMILKPDDRNLGDDTWMPPGKIWMRMFAKNTNACWPEGCRDDNEEDDCGTHNLHRMC
123  
124  >ntazzewyvv
125  CGCKIF D D NMKDNNRHG TDIKKHGFMH IRHPE KRDDC FDNHCIMPKHRRWGLWD
126  EASINM AQQWRSLPPSRIMKLNG       HGCDCMHSHMEAD   DTKQSGIKGTFWNG  HDAQWLCRWG      
127  EFITEA WWGRWGAITFFHAH  ENKNEIQECSDQNLKE        SRTTCEIID   TCHLFTRHLDGW 
128    RCEKCQANATHMTW ACTKSCAEQW  FCAKELMMN    
129    W        KQMGWRCKIFRKLFRDNCWID  FELPWWPICFCCKGLSTKSHSAHDGDQCRRW    WPDCARDWLGPGIRGEF   
130    FCTHICQQLQRNFWCGCFRWNIEKRMFEIFDDNMAAHWKKCMHFKFLIRIHRHGPITMKMTWCRSGCCFGKTRRLPDSSFISAFLDPKHHRDGSGMMMWSSEMRSCAIPDPQQAWNQGKWIGQIKDWNICFAWPIRENQQCWATPHEMPSGFHFILEKWDALAHPHMHIRQKKCWAWAFLSLMSSTHSDMATFQWAIPGHNIWSNWDNIICGWPRI
131  
132     > 12 d t y wi               k       jbke    
133    KLSHHDCD
134     N
135      H
136      HSKCTEPHCGNSHQMLHRDP
137      CCDQCQSWEAENWCASMRKAILF
138  
139  </pre>\r
140 <P>\r
141 \r
142 <P>\r
143 <DL>\r
144 <DT><B>Version:</B></DT>\r
145   <DD>1.0 April 2011</DD>\r
146 <DT><B>Author:</B></DT>\r
147   <DD>Peter Troshin</DD>\r
148 </DL>\r
149 <HR>\r
150 \r
151 <P>\r
152 \r
153 <!-- ======== CONSTRUCTOR SUMMARY ======== -->\r
154 \r
155 <A NAME="constructor_summary"><!-- --></A>\r
156 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
157 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
158 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
159 <B>Constructor Summary</B></FONT></TH>\r
160 </TR>\r
161 <TR BGCOLOR="white" CLASS="TableRowColor">\r
162 <TD><CODE><B><A HREF="../../../compbio/data/sequence/FastaReader.html#FastaReader(java.io.InputStream)">FastaReader</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</A>&nbsp;inputStream)</CODE>\r
163 \r
164 <BR>\r
165 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This class will not close the incoming stream! So the client should do
166  so.</TD>\r
167 </TR>\r
168 <TR BGCOLOR="white" CLASS="TableRowColor">\r
169 <TD><CODE><B><A HREF="../../../compbio/data/sequence/FastaReader.html#FastaReader(java.lang.String)">FastaReader</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;inputFile)</CODE>\r
170 \r
171 <BR>\r
172 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Header data can contain non-ASCII symbols and read in UTF8</TD>\r
173 </TR>\r
174 </TABLE>\r
175 &nbsp;\r
176 <!-- ========== METHOD SUMMARY =========== -->\r
177 \r
178 <A NAME="method_summary"><!-- --></A>\r
179 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
180 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
181 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
182 <B>Method Summary</B></FONT></TH>\r
183 </TR>\r
184 <TR BGCOLOR="white" CLASS="TableRowColor">\r
185 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
186 <CODE>&nbsp;void</CODE></FONT></TD>\r
187 <TD><CODE><B><A HREF="../../../compbio/data/sequence/FastaReader.html#close()">close</A></B>()</CODE>\r
188 \r
189 <BR>\r
190 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Call this method to close the connection to the input file if you want to
191  free up the resources.</TD>\r
192 </TR>\r
193 <TR BGCOLOR="white" CLASS="TableRowColor">\r
194 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
195 <CODE>&nbsp;boolean</CODE></FONT></TD>\r
196 <TD><CODE><B><A HREF="../../../compbio/data/sequence/FastaReader.html#hasNext()">hasNext</A></B>()</CODE>\r
197 \r
198 <BR>\r
199 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
200 </TR>\r
201 <TR BGCOLOR="white" CLASS="TableRowColor">\r
202 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
203 <CODE>&nbsp;<A HREF="../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</A></CODE></FONT></TD>\r
204 <TD><CODE><B><A HREF="../../../compbio/data/sequence/FastaReader.html#next()">next</A></B>()</CODE>\r
205 \r
206 <BR>\r
207 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reads the next FastaSequence from the input</TD>\r
208 </TR>\r
209 <TR BGCOLOR="white" CLASS="TableRowColor">\r
210 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
211 <CODE>&nbsp;void</CODE></FONT></TD>\r
212 <TD><CODE><B><A HREF="../../../compbio/data/sequence/FastaReader.html#remove()">remove</A></B>()</CODE>\r
213 \r
214 <BR>\r
215 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Not implemented</TD>\r
216 </TR>\r
217 </TABLE>\r
218 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>\r
219 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
220 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
221 <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
222 </TR>\r
223 <TR BGCOLOR="white" CLASS="TableRowColor">\r
224 <TD><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>, <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#hashCode()" title="class or interface in java.lang">hashCode</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#toString()" title="class or interface in java.lang">toString</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
225 </TR>\r
226 </TABLE>\r
227 &nbsp;\r
228 <P>\r
229 \r
230 <!-- ========= CONSTRUCTOR DETAIL ======== -->\r
231 \r
232 <A NAME="constructor_detail"><!-- --></A>\r
233 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
234 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
235 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
236 <B>Constructor Detail</B></FONT></TH>\r
237 </TR>\r
238 </TABLE>\r
239 \r
240 <A NAME="FastaReader(java.lang.String)"><!-- --></A><H3>\r
241 FastaReader</H3>\r
242 <PRE>\r
243 public <B>FastaReader</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;inputFile)\r
244             throws <A HREF="http://java.sun.com/javase/6/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</A></PRE>\r
245 <DL>\r
246 <DD>Header data can contain non-ASCII symbols and read in UTF8\r
247 <P>\r
248 <DL>\r
249 <DT><B>Parameters:</B><DD><CODE>inputFile</CODE> - the file containing the list of FASTA formatted sequences to
250             read from\r
251 <DT><B>Throws:</B>\r
252 <DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</A></CODE> - if the input file is not found\r
253 <DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</A></CODE> - if the close method was called on this instance</DL>\r
254 </DL>\r
255 <HR>\r
256 \r
257 <A NAME="FastaReader(java.io.InputStream)"><!-- --></A><H3>\r
258 FastaReader</H3>\r
259 <PRE>\r
260 public <B>FastaReader</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</A>&nbsp;inputStream)\r
261             throws <A HREF="http://java.sun.com/javase/6/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</A></PRE>\r
262 <DL>\r
263 <DD>This class will not close the incoming stream! So the client should do
264  so.\r
265 <P>\r
266 <DL>\r
267 <DT><B>Parameters:</B><DD><CODE>inputStream</CODE> - \r
268 <DT><B>Throws:</B>\r
269 <DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</A></CODE></DL>\r
270 </DL>\r
271 \r
272 <!-- ============ METHOD DETAIL ========== -->\r
273 \r
274 <A NAME="method_detail"><!-- --></A>\r
275 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
276 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
277 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
278 <B>Method Detail</B></FONT></TH>\r
279 </TR>\r
280 </TABLE>\r
281 \r
282 <A NAME="hasNext()"><!-- --></A><H3>\r
283 hasNext</H3>\r
284 <PRE>\r
285 public boolean <B>hasNext</B>()</PRE>\r
286 <DL>\r
287 <DD>\r
288 <P>\r
289 <DD><DL>\r
290 <DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Iterator.html?is-external=true#hasNext()" title="class or interface in java.util">hasNext</A></CODE> in interface <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</A>&lt;<A HREF="../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</A>&gt;</CODE></DL>\r
291 </DD>\r
292 <DD><DL>\r
293 \r
294 <DT><B>Throws:</B>\r
295 <DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</A></CODE> - if the close method was called on this instance</DL>\r
296 </DD>\r
297 </DL>\r
298 <HR>\r
299 \r
300 <A NAME="next()"><!-- --></A><H3>\r
301 next</H3>\r
302 <PRE>\r
303 public <A HREF="../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</A> <B>next</B>()</PRE>\r
304 <DL>\r
305 <DD>Reads the next FastaSequence from the input\r
306 <P>\r
307 <DD><DL>\r
308 <DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Iterator.html?is-external=true#next()" title="class or interface in java.util">next</A></CODE> in interface <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</A>&lt;<A HREF="../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</A>&gt;</CODE></DL>\r
309 </DD>\r
310 <DD><DL>\r
311 \r
312 <DT><B>Throws:</B>\r
313 <DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/AssertionError.html?is-external=true" title="class or interface in java.lang">AssertionError</A></CODE> - if the header or the sequence is missing\r
314 <DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</A></CODE> - if the close method was called on this instance</DL>\r
315 </DD>\r
316 </DL>\r
317 <HR>\r
318 \r
319 <A NAME="remove()"><!-- --></A><H3>\r
320 remove</H3>\r
321 <PRE>\r
322 public void <B>remove</B>()</PRE>\r
323 <DL>\r
324 <DD>Not implemented\r
325 <P>\r
326 <DD><DL>\r
327 <DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Iterator.html?is-external=true#remove()" title="class or interface in java.util">remove</A></CODE> in interface <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</A>&lt;<A HREF="../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</A>&gt;</CODE></DL>\r
328 </DD>\r
329 <DD><DL>\r
330 </DL>\r
331 </DD>\r
332 </DL>\r
333 <HR>\r
334 \r
335 <A NAME="close()"><!-- --></A><H3>\r
336 close</H3>\r
337 <PRE>\r
338 public void <B>close</B>()</PRE>\r
339 <DL>\r
340 <DD>Call this method to close the connection to the input file if you want to
341  free up the resources. The connection will be closed on the JVM shutdown
342  if this method was not called explicitly. No further reading on this
343  instance of the FastaReader will be possible after calling this method.\r
344 <P>\r
345 <DD><DL>\r
346 </DL>\r
347 </DD>\r
348 <DD><DL>\r
349 </DL>\r
350 </DD>\r
351 </DL>\r
352 <!-- ========= END OF CLASS DATA ========= -->\r
353 <HR>\r
354 \r
355 \r
356 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
357 <A NAME="navbar_bottom"><!-- --></A>\r
358 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>\r
359 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
360 <TR>\r
361 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
362 <A NAME="navbar_bottom_firstrow"><!-- --></A>\r
363 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
364   <TR ALIGN="center" VALIGN="top">\r
365   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
366   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
367   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
368   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/FastaReader.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
369   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
370   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
371   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
372   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
373   </TR>\r
374 </TABLE>\r
375 </TD>\r
376 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
377 </EM>\r
378 </TD>\r
379 </TR>\r
380 \r
381 <TR>\r
382 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
383 &nbsp;<A HREF="../../../compbio/data/sequence/DisorderMethod.html" title="enum in compbio.data.sequence"><B>PREV CLASS</B></A>&nbsp;\r
384 &nbsp;<A HREF="../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence"><B>NEXT CLASS</B></A></FONT></TD>\r
385 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
386   <A HREF="../../../index.html?compbio/data/sequence/FastaReader.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
387 &nbsp;<A HREF="FastaReader.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
388 &nbsp;<SCRIPT type="text/javascript">\r
389   <!--\r
390   if(window==top) {\r
391     document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
392   }\r
393   //-->\r
394 </SCRIPT>\r
395 <NOSCRIPT>\r
396   <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>\r
397 </NOSCRIPT>\r
398 \r
399 \r
400 </FONT></TD>\r
401 </TR>\r
402 <TR>\r
403 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
404   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
405 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
406 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
407 </TR>\r
408 </TABLE>\r
409 <A NAME="skip-navbar_bottom"></A>\r
410 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
411 \r
412 <HR>\r
413 \r
414 </BODY>\r
415 </HTML>\r