Minor grammar fixes
[openafs-wiki.git] / archive / JavaAdminAPI / FileInputStream.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
2 <!--NewPage-->
3 <HTML>
4 <HEAD>
5 <!-- Generated by javadoc on Mon Jun 09 15:53:37 PDT 2003 -->
6 <TITLE>
7 FileInputStream (Java AFS API)
8 </TITLE>
9 <META NAME="keywords" CONTENT="org.openafs.jafs.FileInputStream,FileInputStream class">
10 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
11 </HEAD>
12 <SCRIPT>
13 function asd()
14 {
15 parent.document.title="FileInputStream (Java AFS API)";
16 }
17 </SCRIPT>
18 <BODY BGCOLOR="white" onload="asd();">
19
20 <!-- ========== START OF NAVBAR ========== -->
21 <A NAME="navbar_top"><!-- --></A>
22 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
23 <TR>
24 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
25 <A NAME="navbar_top_firstrow"><!-- --></A>
26 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
27   <TR ALIGN="center" VALIGN="top">
28   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
29   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
30   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/FileInputStream.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
31   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
32   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
33   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
34   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
35   </TR>
36 </TABLE>
37 </TD>
38 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
39 <B>JAFS API v2</B></EM>
40 </TD>
41 </TR>
42
43 <TR>
44 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
45 &nbsp;<A HREF="../../../org/openafs/jafs/File.html"><B>PREV CLASS</B></A>&nbsp;
46 &nbsp;<A HREF="../../../org/openafs/jafs/FileOutputStream.html"><B>NEXT CLASS</B></A></FONT></TD>
47 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
48   <A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
49 &nbsp;<A HREF="FileInputStream.html" TARGET="_top"><B>NO FRAMES</B></A>  &nbsp;
50 &nbsp;
51 <SCRIPT>
52   <!--
53   if(window==top) {
54     document.writeln('<A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
55   }
56   //-->
57 </SCRIPT>
58 <NOSCRIPT>
59 <A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
60 </NOSCRIPT>
61 </FONT></TD>
62 </TR>
63 <TR>
64 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
65   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
66 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
67 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
68 </TR>
69 </TABLE>
70 <!-- =========== END OF NAVBAR =========== -->
71
72 <HR>
73 <!-- ======== START OF CLASS DATA ======== -->
74 <H2>
75 <FONT SIZE="-1">
76 org.openafs.jafs</FONT>
77 <BR>
78 Class FileInputStream</H2>
79 <PRE>
80 <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html">java.lang.Object</A>
81   |
82   +--<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/InputStream.html">java.io.InputStream</A>
83         |
84         +--<B>org.openafs.jafs.FileInputStream</B>
85 </PRE>
86 <HR>
87 <DL>
88 <DT>public class <B>FileInputStream</B><DT>extends <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/InputStream.html">InputStream</A></DL>
89
90 <P>
91 This class is a file input stream for files within AFS.  
92  It is an input stream for reading data from a 
93  <code><A HREF="../../../org/openafs/jafs/File.html"><CODE>File</CODE></A></code>.
94 <P>
95
96 <P>
97 <DL>
98 <DT><B>Version:</B></DT>
99   <DD>2.1, 08/03/2001</DD>
100 <DT><B>See Also:</B><DD><A HREF="../../../org/openafs/jafs/File.html"><CODE>File</CODE></A>, 
101 <A HREF="../../../org/openafs/jafs/FileOutputStream.html"><CODE>FileOutputStream</CODE></A>, 
102 <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/FileInputStream.html"><CODE>FileInputStream</CODE></A></DL>
103 <HR>
104
105 <P>
106 <!-- ======== NESTED CLASS SUMMARY ======== -->
107
108
109 <!-- =========== FIELD SUMMARY =========== -->
110
111
112 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
113
114 <A NAME="constructor_summary"><!-- --></A>
115 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
116 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
117 <TD COLSPAN=2><FONT SIZE="+2">
118 <B>Constructor Summary</B></FONT></TD>
119 </TR>
120 <TR BGCOLOR="white" CLASS="TableRowColor">
121 <TD><CODE><B><A HREF="../../../org/openafs/jafs/FileInputStream.html#FileInputStream(org.openafs.jafs.File)">FileInputStream</A></B>(<A HREF="../../../org/openafs/jafs/File.html">File</A>&nbsp;file)</CODE>
122
123 <BR>
124 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a <code>FileInputStream</code> by
125  opening a connection to an actual AFS file,
126  the file represented by file <code>file</code>
127  in the AFS file system.</TD>
128 </TR>
129 <TR BGCOLOR="white" CLASS="TableRowColor">
130 <TD><CODE><B><A HREF="../../../org/openafs/jafs/FileInputStream.html#FileInputStream(java.lang.String)">FileInputStream</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>&nbsp;name)</CODE>
131
132 <BR>
133 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a <code>FileInputStream</code> by
134  opening a connection to an actual AFS file,
135  the file named by the path name <code>name</code>
136  in the AFS file system.</TD>
137 </TR>
138 </TABLE>
139 &nbsp;
140 <!-- ========== METHOD SUMMARY =========== -->
141
142 <A NAME="method_summary"><!-- --></A>
143 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
144 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
145 <TD COLSPAN=2><FONT SIZE="+2">
146 <B>Method Summary</B></FONT></TD>
147 </TR>
148 <TR BGCOLOR="white" CLASS="TableRowColor">
149 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
150 <CODE>&nbsp;void</CODE></FONT></TD>
151 <TD><CODE><B><A HREF="../../../org/openafs/jafs/FileInputStream.html#close()">close</A></B>()</CODE>
152
153 <BR>
154 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Closes this file input stream and releases any system resources
155  associated with the stream.</TD>
156 </TR>
157 <TR BGCOLOR="white" CLASS="TableRowColor">
158 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
159 <CODE>&nbsp;int</CODE></FONT></TD>
160 <TD><CODE><B><A HREF="../../../org/openafs/jafs/FileInputStream.html#read()">read</A></B>()</CODE>
161
162 <BR>
163 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reads the next byte of data from this input stream. </TD>
164 </TR>
165 <TR BGCOLOR="white" CLASS="TableRowColor">
166 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
167 <CODE>&nbsp;int</CODE></FONT></TD>
168 <TD><CODE><B><A HREF="../../../org/openafs/jafs/FileInputStream.html#read(byte[])">read</A></B>(byte[]&nbsp;b)</CODE>
169
170 <BR>
171 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reads up to <code>b.length</code> bytes of data from this input
172  stream into an array of bytes. </TD>
173 </TR>
174 <TR BGCOLOR="white" CLASS="TableRowColor">
175 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
176 <CODE>&nbsp;int</CODE></FONT></TD>
177 <TD><CODE><B><A HREF="../../../org/openafs/jafs/FileInputStream.html#read(byte[], int, int)">read</A></B>(byte[]&nbsp;b,
178      int&nbsp;off,
179      int&nbsp;len)</CODE>
180
181 <BR>
182 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reads up to <code>len</code> bytes of data from this input stream
183  into an array of bytes. </TD>
184 </TR>
185 <TR BGCOLOR="white" CLASS="TableRowColor">
186 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
187 <CODE>&nbsp;long</CODE></FONT></TD>
188 <TD><CODE><B><A HREF="../../../org/openafs/jafs/FileInputStream.html#skip(long)">skip</A></B>(long&nbsp;n)</CODE>
189
190 <BR>
191 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Skips over and discards <code>n</code> bytes of data from the
192  input stream. </TD>
193 </TR>
194 </TABLE>
195 &nbsp;<A NAME="methods_inherited_from_class_java.io.InputStream"><!-- --></A>
196 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
197 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
198 <TD><B>Methods inherited from class java.io.<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/InputStream.html">InputStream</A></B></TD>
199 </TR>
200 <TR BGCOLOR="white" CLASS="TableRowColor">
201 <TD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/InputStream.html#available()">available</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/InputStream.html#mark(int)">mark</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/InputStream.html#markSupported()">markSupported</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/InputStream.html#reset()">reset</A></CODE></TD>
202 </TR>
203 </TABLE>
204 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
205 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
206 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
207 <TD><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html">Object</A></B></TD>
208 </TR>
209 <TR BGCOLOR="white" CLASS="TableRowColor">
210 <TD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#clone()">clone</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#equals(java.lang.Object)">equals</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#finalize()">finalize</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#getClass()">getClass</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#hashCode()">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#notify()">notify</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#notifyAll()">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#toString()">toString</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#wait()">wait</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#wait(long)">wait</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#wait(long, int)">wait</A></CODE></TD>
211 </TR>
212 </TABLE>
213 &nbsp;
214 <P>
215
216 <!-- ============ FIELD DETAIL =========== -->
217
218
219 <!-- ========= CONSTRUCTOR DETAIL ======== -->
220
221 <A NAME="constructor_detail"><!-- --></A>
222 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
223 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
224 <TD COLSPAN=1><FONT SIZE="+2">
225 <B>Constructor Detail</B></FONT></TD>
226 </TR>
227 </TABLE>
228
229 <A NAME="FileInputStream(java.lang.String)"><!-- --></A><H3>
230 FileInputStream</H3>
231 <PRE>
232 public <B>FileInputStream</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html">String</A>&nbsp;name)
233                 throws <A HREF="../../../org/openafs/jafs/AFSFileException.html">AFSFileException</A></PRE>
234 <DL>
235 <DD>Creates a <code>FileInputStream</code> by
236  opening a connection to an actual AFS file,
237  the file named by the path name <code>name</code>
238  in the AFS file system.
239 <P>
240 <DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the file to read from
241 <DT><B>Throws:</B>
242 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSFileException.html">AFSFileException</A></CODE> - If an AFS specific error occurs, 
243                         if the file does not, or cannot be opened for any 
244                         other reason, including authorization.</DL>
245 <HR>
246
247 <A NAME="FileInputStream(org.openafs.jafs.File)"><!-- --></A><H3>
248 FileInputStream</H3>
249 <PRE>
250 public <B>FileInputStream</B>(<A HREF="../../../org/openafs/jafs/File.html">File</A>&nbsp;file)
251                 throws <A HREF="../../../org/openafs/jafs/AFSFileException.html">AFSFileException</A></PRE>
252 <DL>
253 <DD>Creates a <code>FileInputStream</code> by
254  opening a connection to an actual AFS file,
255  the file represented by file <code>file</code>
256  in the AFS file system.
257 <P>
258 <DT><B>Parameters:</B><DD><CODE>file</CODE> - an AFS file object representing a file to read from
259 <DT><B>Throws:</B>
260 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSFileException.html">AFSFileException</A></CODE> - If an AFS specific error occurs, 
261                         if the file does not, or cannot be opened for any 
262                         other reason, including authorization.</DL>
263
264 <!-- ============ METHOD DETAIL ========== -->
265
266 <A NAME="method_detail"><!-- --></A>
267 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
268 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
269 <TD COLSPAN=1><FONT SIZE="+2">
270 <B>Method Detail</B></FONT></TD>
271 </TR>
272 </TABLE>
273
274 <A NAME="read()"><!-- --></A><H3>
275 read</H3>
276 <PRE>
277 public int <B>read</B>()
278          throws <A HREF="../../../org/openafs/jafs/AFSFileException.html">AFSFileException</A></PRE>
279 <DL>
280 <DD>Reads the next byte of data from this input stream. The value 
281  byte is returned as an <code>int</code> in the range 
282  <code>0</code> to <code>255</code>. If no byte is available 
283  because the end of the stream has been reached, the value 
284  <code>-1</code> is returned. This method blocks until input data 
285  is available, the end of the stream is detected, or an exception 
286  is thrown. 
287
288  <p>This method simply performs <code>in.read()</code> and returns 
289  the result.
290 <P>
291 <DD><DL>
292 <DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/InputStream.html#read()">read</A></CODE> in class <CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/InputStream.html">InputStream</A></CODE></DL>
293 </DD>
294 <DD><DL>
295
296 <DT><B>Returns:</B><DD>the next byte of data, or <code>-1</code> if the end of the
297            stream is reached.
298 <DT><B>Throws:</B>
299 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSFileException.html">AFSFileException</A></CODE> - if an I/O or other file related error occurs.<DT><B>See Also:</B><DD><CODE>FileInputStream.read()</CODE></DL>
300 </DD>
301 </DL>
302 <HR>
303
304 <A NAME="read(byte[])"><!-- --></A><H3>
305 read</H3>
306 <PRE>
307 public int <B>read</B>(byte[]&nbsp;b)
308          throws <A HREF="../../../org/openafs/jafs/AFSFileException.html">AFSFileException</A></PRE>
309 <DL>
310 <DD>Reads up to <code>b.length</code> bytes of data from this input
311  stream into an array of bytes. This method blocks until some input
312  is available.
313 <P>
314 <DD><DL>
315 <DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/InputStream.html#read(byte[])">read</A></CODE> in class <CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/InputStream.html">InputStream</A></CODE></DL>
316 </DD>
317 <DD><DL>
318 <DT><B>Parameters:</B><DD><CODE>b</CODE> - the buffer into which the data is read.
319 <DT><B>Returns:</B><DD>the total number of bytes read into the buffer, or
320              <code>-1</code> if there is no more data because the end of
321              the file has been reached.
322 <DT><B>Throws:</B>
323 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSFileException.html">AFSFileException</A></CODE> - if an I/O or other file related error occurs.</DL>
324 </DD>
325 </DL>
326 <HR>
327
328 <A NAME="read(byte[], int, int)"><!-- --></A><H3>
329 read</H3>
330 <PRE>
331 public int <B>read</B>(byte[]&nbsp;b,
332                 int&nbsp;off,
333                 int&nbsp;len)
334          throws <A HREF="../../../org/openafs/jafs/AFSFileException.html">AFSFileException</A></PRE>
335 <DL>
336 <DD>Reads up to <code>len</code> bytes of data from this input stream
337  into an array of bytes. This method blocks until some input is
338  available.
339 <P>
340 <DD><DL>
341 <DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/InputStream.html#read(byte[], int, int)">read</A></CODE> in class <CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/InputStream.html">InputStream</A></CODE></DL>
342 </DD>
343 <DD><DL>
344 <DT><B>Parameters:</B><DD><CODE>b</CODE> - the buffer into which the data is read.<DD><CODE>off</CODE> - the start offset of the data.<DD><CODE>len</CODE> - the maximum number of bytes read.
345 <DT><B>Returns:</B><DD>the total number of bytes read into the buffer, or
346              <code>-1</code> if there is no more data because the end of
347              the file has been reached.
348 <DT><B>Throws:</B>
349 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSFileException.html">AFSFileException</A></CODE> - if an I/O or other file related error occurs.</DL>
350 </DD>
351 </DL>
352 <HR>
353
354 <A NAME="skip(long)"><!-- --></A><H3>
355 skip</H3>
356 <PRE>
357 public long <B>skip</B>(long&nbsp;n)
358           throws <A HREF="../../../org/openafs/jafs/AFSFileException.html">AFSFileException</A></PRE>
359 <DL>
360 <DD>Skips over and discards <code>n</code> bytes of data from the
361  input stream. The <code>skip</code> method may, for a variety of
362  reasons, end up skipping over some smaller number of bytes,
363  possibly <code>0</code>. The actual number of bytes skipped is returned.
364 <P>
365 <DD><DL>
366 <DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/InputStream.html#skip(long)">skip</A></CODE> in class <CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/InputStream.html">InputStream</A></CODE></DL>
367 </DD>
368 <DD><DL>
369 <DT><B>Parameters:</B><DD><CODE>n</CODE> - the number of bytes to be skipped.
370 <DT><B>Returns:</B><DD>the actual number of bytes skipped.
371 <DT><B>Throws:</B>
372 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSFileException.html">AFSFileException</A></CODE> - if an I/O or other file related error occurs.</DL>
373 </DD>
374 </DL>
375 <HR>
376
377 <A NAME="close()"><!-- --></A><H3>
378 close</H3>
379 <PRE>
380 public void <B>close</B>()
381            throws <A HREF="../../../org/openafs/jafs/AFSFileException.html">AFSFileException</A></PRE>
382 <DL>
383 <DD>Closes this file input stream and releases any system resources
384  associated with the stream.
385 <P>
386 <DD><DL>
387 <DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/InputStream.html#close()">close</A></CODE> in class <CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/InputStream.html">InputStream</A></CODE></DL>
388 </DD>
389 <DD><DL>
390
391 <DT><B>Throws:</B>
392 <DD><CODE><A HREF="../../../org/openafs/jafs/AFSFileException.html">AFSFileException</A></CODE> - if an I/O or other file related error occurs.</DL>
393 </DD>
394 </DL>
395 <!-- ========= END OF CLASS DATA ========= -->
396 <HR>
397
398 <!-- ========== START OF NAVBAR ========== -->
399 <A NAME="navbar_bottom"><!-- --></A>
400 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
401 <TR>
402 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
403 <A NAME="navbar_bottom_firstrow"><!-- --></A>
404 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
405   <TR ALIGN="center" VALIGN="top">
406   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
407   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
408   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/FileInputStream.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
409   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
410   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
411   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
412   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
413   </TR>
414 </TABLE>
415 </TD>
416 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
417 <B>JAFS API v2</B></EM>
418 </TD>
419 </TR>
420
421 <TR>
422 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
423 &nbsp;<A HREF="../../../org/openafs/jafs/File.html"><B>PREV CLASS</B></A>&nbsp;
424 &nbsp;<A HREF="../../../org/openafs/jafs/FileOutputStream.html"><B>NEXT CLASS</B></A></FONT></TD>
425 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
426   <A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
427 &nbsp;<A HREF="FileInputStream.html" TARGET="_top"><B>NO FRAMES</B></A>  &nbsp;
428 &nbsp;
429 <SCRIPT>
430   <!--
431   if(window==top) {
432     document.writeln('<A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
433   }
434   //-->
435 </SCRIPT>
436 <NOSCRIPT>
437 <A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
438 </NOSCRIPT>
439 </FONT></TD>
440 </TR>
441 <TR>
442 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
443   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
444 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
445 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
446 </TR>
447 </TABLE>
448 <!-- =========== END OF NAVBAR =========== -->
449
450 <HR>
451
452 </BODY>
453 </HTML>