nxtOSEK/lejos_nxj/docs/apidocs/java/io/FileInputStream.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <!--NewPage-->
   3 <HTML>
   4 <HEAD>
   5 <!-- Generated by javadoc (build 1.5.0_09) on Sun Sep 02 23:07:09 BST 2007 -->
   6 <TITLE>
   7 FileInputStream (leJOS NXT API documentation)
   8 </TITLE>
   9
  10 <META NAME="keywords" CONTENT="java.io.FileInputStream class">
  11
  12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
  13
  14 <SCRIPT type="text/javascript">
  15 function windowTitle()
  16 {
  17     parent.document.title="FileInputStream (leJOS NXT API documentation)";
  18 }
  19 </SCRIPT>
  20 <NOSCRIPT>
  21 </NOSCRIPT>
  22
  23 </HEAD>
  24
  25 <BODY BGCOLOR="white" onload="windowTitle();">
  26
  27
  28 <!-- ========= START OF TOP NAVBAR ======= -->
  29 <A NAME="navbar_top"><!-- --></A>
  30 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
  31 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  32 <TR>
  33 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  34 <A NAME="navbar_top_firstrow"><!-- --></A>
  35 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  36   <TR ALIGN="center" VALIGN="top">
  37   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  38   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  39   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  40   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  41   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  42   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  43   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  44   </TR>
  45 </TABLE>
  46 </TD>
  47 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  48 </EM>
  49 </TD>
  50 </TR>
  51
  52 <TR>
  53 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  54 &nbsp;<A HREF="../../java/io/File.html" title="class in java.io"><B>PREV CLASS</B></A>&nbsp;
  55 &nbsp;<A HREF="../../java/io/FileOutputStream.html" title="class in java.io"><B>NEXT CLASS</B></A></FONT></TD>
  56 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  57   <A HREF="../../index.html?java/io/FileInputStream.html" target="_top"><B>FRAMES</B></A>  &nbsp;
  58 &nbsp;<A HREF="FileInputStream.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
  59 &nbsp;<SCRIPT type="text/javascript">
  60   <!--
  61   if(window==top) {
  62     document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
  63   }
  64   //-->
  65 </SCRIPT>
  66 <NOSCRIPT>
  67   <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
  68 </NOSCRIPT>
  69
  70
  71 </FONT></TD>
  72 </TR>
  73 <TR>
  74 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  75   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  76 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  77 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  78 </TR>
  79 </TABLE>
  80 <A NAME="skip-navbar_top"></A>
  81 <!-- ========= END OF TOP NAVBAR ========= -->
  82
  83 <HR>
  84 <!-- ======== START OF CLASS DATA ======== -->
  85 <H2>
  86 <FONT SIZE="-1">
  87 java.io</FONT>
  88 <BR>
  89 Class FileInputStream</H2>
  90 <PRE>
  91 <A HREF="../../java/lang/Object.html" title="class in java.lang">java.lang.Object</A>
  92   <IMG SRC="../../resources/inherit.gif" ALT="extended by "><A HREF="../../java/io/InputStream.html" title="class in java.io">java.io.InputStream</A>
  93       <IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>java.io.FileInputStream</B>
  94 </PRE>
  95 <HR>
  96 <DL>
  97 <DT><PRE>public class <B>FileInputStream</B><DT>extends <A HREF="../../java/io/InputStream.html" title="class in java.io">InputStream</A></DL>
  98 </PRE>
  99
 100 <P>
 101 <HR>
 102
 103 <P>
 104
 105 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 106
 107 <A NAME="constructor_summary"><!-- --></A>
 108 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 109 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 110 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 111 <B>Constructor Summary</B></FONT></TH>
 112 </TR>
 113 <TR BGCOLOR="white" CLASS="TableRowColor">
 114 <TD><CODE><B><A HREF="../../java/io/FileInputStream.html#FileInputStream(java.io.File)">FileInputStream</A></B>(<A HREF="../../java/io/File.html" title="class in java.io">File</A>&nbsp;f)</CODE>
 115
 116 <BR>
 117 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 118 </TR>
 119 </TABLE>
 120 &nbsp;
 121 <!-- ========== METHOD SUMMARY =========== -->
 122
 123 <A NAME="method_summary"><!-- --></A>
 124 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 125 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 126 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 127 <B>Method Summary</B></FONT></TH>
 128 </TR>
 129 <TR BGCOLOR="white" CLASS="TableRowColor">
 130 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 131 <CODE>&nbsp;int</CODE></FONT></TD>
 132 <TD><CODE><B><A HREF="../../java/io/FileInputStream.html#read()">read</A></B>()</CODE>
 133
 134 <BR>
 135 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reads the next byte of data from the input stream.</TD>
 136 </TR>
 137 <TR BGCOLOR="white" CLASS="TableRowColor">
 138 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 139 <CODE>&nbsp;void</CODE></FONT></TD>
 140 <TD><CODE><B><A HREF="../../java/io/FileInputStream.html#reset()">reset</A></B>()</CODE>
 141
 142 <BR>
 143 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;resets pointers so next read() is from the start of the file;</TD>
 144 </TR>
 145 </TABLE>
 146 &nbsp;<A NAME="methods_inherited_from_class_java.io.InputStream"><!-- --></A>
 147 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 148 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 149 <TH ALIGN="left"><B>Methods inherited from class java.io.<A HREF="../../java/io/InputStream.html" title="class in java.io">InputStream</A></B></TH>
 150 </TR>
 151 <TR BGCOLOR="white" CLASS="TableRowColor">
 152 <TD><CODE><A HREF="../../java/io/InputStream.html#available()">available</A>, <A HREF="../../java/io/InputStream.html#close()">close</A>, <A HREF="../../java/io/InputStream.html#mark(int)">mark</A>, <A HREF="../../java/io/InputStream.html#markSupported()">markSupported</A>, <A HREF="../../java/io/InputStream.html#read(byte[])">read</A>, <A HREF="../../java/io/InputStream.html#read(byte[], int, int)">read</A>, <A HREF="../../java/io/InputStream.html#skip(long)">skip</A></CODE></TD>
 153 </TR>
 154 </TABLE>
 155 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
 156 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 157 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 158 <TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="../../java/lang/Object.html" title="class in java.lang">Object</A></B></TH>
 159 </TR>
 160 <TR BGCOLOR="white" CLASS="TableRowColor">
 161 <TD><CODE><A HREF="../../java/lang/Object.html#equals(java.lang.Object)">equals</A>, <A HREF="../../java/lang/Object.html#getClass()">getClass</A>, <A HREF="../../java/lang/Object.html#hashCode()">hashCode</A>, <A HREF="../../java/lang/Object.html#notify()">notify</A>, <A HREF="../../java/lang/Object.html#notifyAll()">notifyAll</A>, <A HREF="../../java/lang/Object.html#toString()">toString</A>, <A HREF="../../java/lang/Object.html#wait()">wait</A>, <A HREF="../../java/lang/Object.html#wait(long)">wait</A></CODE></TD>
 162 </TR>
 163 </TABLE>
 164 &nbsp;
 165 <P>
 166
 167 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 168
 169 <A NAME="constructor_detail"><!-- --></A>
 170 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 171 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 172 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 173 <B>Constructor Detail</B></FONT></TH>
 174 </TR>
 175 </TABLE>
 176
 177 <A NAME="FileInputStream(java.io.File)"><!-- --></A><H3>
 178 FileInputStream</H3>
 179 <PRE>
 180 public <B>FileInputStream</B>(<A HREF="../../java/io/File.html" title="class in java.io">File</A>&nbsp;f)</PRE>
 181 <DL>
 182 </DL>
 183
 184 <!-- ============ METHOD DETAIL ========== -->
 185
 186 <A NAME="method_detail"><!-- --></A>
 187 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 188 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 189 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 190 <B>Method Detail</B></FONT></TH>
 191 </TR>
 192 </TABLE>
 193
 194 <A NAME="read()"><!-- --></A><H3>
 195 read</H3>
 196 <PRE>
 197 public int <B>read</B>()
 198          throws <A HREF="../../java/io/IOException.html" title="class in java.io">IOException</A></PRE>
 199 <DL>
 200 <DD><B>Description copied from class: <CODE><A HREF="../../java/io/InputStream.html#read()">InputStream</A></CODE></B></DD>
 201 <DD>Reads the next byte of data from the input stream. The value byte is
 202  returned as an <code>int</code> in the range <code>0</code> to
 203  <code>255</code>. If no byte is available because the end of the stream
 204  has been reached, the value <code>-1</code> is returned. This method
 205  blocks until input data is available, the end of the stream is detected,
 206  or an exception is thrown.
 207
 208  <p> A subclass must provide an implementation of this method.
 209 <P>
 210 <DD><DL>
 211 <DT><B>Specified by:</B><DD><CODE><A HREF="../../java/io/InputStream.html#read()">read</A></CODE> in class <CODE><A HREF="../../java/io/InputStream.html" title="class in java.io">InputStream</A></CODE></DL>
 212 </DD>
 213 <DD><DL>
 214
 215 <DT><B>Returns:</B><DD>the next byte of data, or <code>-1</code> if the end of the
 216              stream is reached.
 217 <DT><B>Throws:</B>
 218 <DD><CODE><A HREF="../../java/io/IOException.html" title="class in java.io">IOException</A></CODE> - if an I/O error occurs.</DL>
 219 </DD>
 220 </DL>
 221 <HR>
 222
 223 <A NAME="reset()"><!-- --></A><H3>
 224 reset</H3>
 225 <PRE>
 226 public void <B>reset</B>()</PRE>
 227 <DL>
 228 <DD>resets pointers so next read() is from the start of the file;
 229 <P>
 230 <DD><DL>
 231 <DT><B>Overrides:</B><DD><CODE><A HREF="../../java/io/InputStream.html#reset()">reset</A></CODE> in class <CODE><A HREF="../../java/io/InputStream.html" title="class in java.io">InputStream</A></CODE></DL>
 232 </DD>
 233 <DD><DL>
 234 <DT><B>See Also:</B><DD><A HREF="../../java/io/InputStream.html#mark(int)"><CODE>InputStream.mark(int)</CODE></A>,
 235 <A HREF="../../java/io/IOException.html" title="class in java.io"><CODE>IOException</CODE></A></DL>
 236 </DD>
 237 </DL>
 238 <!-- ========= END OF CLASS DATA ========= -->
 239 <HR>
 240
 241
 242 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 243 <A NAME="navbar_bottom"><!-- --></A>
 244 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
 245 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
 246 <TR>
 247 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 248 <A NAME="navbar_bottom_firstrow"><!-- --></A>
 249 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
 250   <TR ALIGN="center" VALIGN="top">
 251   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
 252   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
 253   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
 254   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
 255   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
 256   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
 257   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
 258   </TR>
 259 </TABLE>
 260 </TD>
 261 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 262 </EM>
 263 </TD>
 264 </TR>
 265
 266 <TR>
 267 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 268 &nbsp;<A HREF="../../java/io/File.html" title="class in java.io"><B>PREV CLASS</B></A>&nbsp;
 269 &nbsp;<A HREF="../../java/io/FileOutputStream.html" title="class in java.io"><B>NEXT CLASS</B></A></FONT></TD>
 270 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 271   <A HREF="../../index.html?java/io/FileInputStream.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 272 &nbsp;<A HREF="FileInputStream.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
 273 &nbsp;<SCRIPT type="text/javascript">
 274   <!--
 275   if(window==top) {
 276     document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
 277   }
 278   //-->
 279 </SCRIPT>
 280 <NOSCRIPT>
 281   <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
 282 </NOSCRIPT>
 283
 284
 285 </FONT></TD>
 286 </TR>
 287 <TR>
 288 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 289   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 290 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 291 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
 292 </TR>
 293 </TABLE>
 294 <A NAME="skip-navbar_bottom"></A>
 295 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 296
 297 <HR>
 298
 299 </BODY>
 300 </HTML>