站内搜索: 请输入搜索关键词
当前页面: 在线文档首页 > JavaTM 2 Platform Standard Edition 5.0 API 规范中文版

InputStream (Java 2 Platform SE 5.0) - JavaTM 2 Platform Standard Edition 5.0 API 规范中文版

概述  软件包   类  使用  树  已过时  索引  帮助 
JavaTM 2 Platform
Standard Ed. 5.0
 上一个类   下一个类 框架    无框架    
摘要： 嵌套 | 字段 | 构造方法 | 方法 详细信息： 字段 | 构造方法 | 方法

java.io
类 InputStream

java.lang.Object
  继承者 java.io.InputStream
所有已实现的接口：
Closeable
直接已知子类：
AudioInputStream, ByteArrayInputStream, FileInputStream, FilterInputStream, InputStream, ObjectInputStream, PipedInputStream, SequenceInputStream, StringBufferInputStream
public abstract class InputStream
extends Object
implements Closeable

此抽象类是表示字节输入流的所有类的超类。

需要定义 InputStream 的子类的应用程序必须始终提供返回下一个输入字节的方法。

从以下版本开始：
JDK1.0
另请参见：
BufferedInputStream, ByteArrayInputStream, DataInputStream, FilterInputStream, read(), OutputStream, PushbackInputStream

构造方法摘要
InputStream()
           
 
方法摘要
 int available()
          返回此输入流方法的下一个调用方可以不受阻塞地从此输入流读取（或跳过）的字节数。
 void close()
          关闭此输入流并释放与该流关联的所有系统资源。
 void mark(int readlimit)
          在此输入流中标记当前的位置。
 boolean markSupported()
          测试此输入流是否支持 mark 和 reset 方法。
abstract  int read()
          从输入流读取下一个数据字节。
 int read(byte[] b)
          从输入流中读取一定数量的字节并将其存储在缓冲区数组 b 中。
 int read(byte[] b, int off, int len)
          将输入流中最多 len 个数据字节读入字节数组。
 void reset()
          将此流重新定位到对此输入流最后调用 mark 方法时的位置。
 long skip(long n)
          跳过和放弃此输入流中的 n 个数据字节。
 
从类 java.lang.Object 继承的方法
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

构造方法详细信息

InputStream

public InputStream()
方法详细信息

read

public abstract int read()
                  throws IOException
从输入流读取下一个数据字节。返回 0 到 255 范围内的 int 字节值。如果因已到达流末尾而没有可用的字节，则返回值 -1。在输入数据可用、检测到流的末尾或者抛出异常前，此方法一直阻塞。

子类必须提供此方法的一个实现。

返回：
下一个数据字节，如果到达流的末尾，则返回 -1。
抛出：
IOException - 如果发生 I/O 错误。

read

public int read(byte[] b)
         throws IOException
从输入流中读取一定数量的字节并将其存储在缓冲区数组 b 中。以整数形式返回实际读取的字节数。在输入数据可用、检测到文件末尾或者抛出异常前，此方法一直阻塞。

如果 b 为 null，将抛出 NullPointerException。如果 b 的长度为 0，则无字节可读且返回 0；否则，要尝试读取至少一个字节。如果因为流位于文件末尾而没有可用的字节，则返回值 -1；否则，至少可以读取一个字节并将其存储在 b 中。

将读取的第一个字节存储在元素 b[0] 中，下一个存储在 b[1] 中，依次类推。读取的字节数最多等于 b 的长度。让 k 为实际读取的字节数；这些字节将存储在元素 b[0] 至 b[k-1] 之间，不影响元素 b[k] 至 b[b.length-1]。

如果不是因为流位于文件末尾而无法读取读取第一个字节，则抛出 IOException。特别是，如果输入流已关闭，则抛出 IOException。

类 InputStream 的 read(b) 方法的效果等同于：

 read(b, 0, b.length)

参数：
b - 读入数据的缓冲区。
返回：
读入缓冲区的总字节数，如果由于流末尾已到达而不再有数据，则返回 -1。
抛出：
IOException - 如果发生 I/O 错误。
NullPointerException - 如果 b 为 null。
另请参见：
read(byte[], int, int)

read

public int read(byte[] b,
                int off,
                int len)
         throws IOException
将输入流中最多 len 个数据字节读入字节数组。尝试读取多达 len 字节，但可能读取较少数量。以整数形式返回实际读取的字节数。

在输入数据可用、检测到流的末尾或者抛出异常前，此方法一直阻塞。

如果 b 为 null，则抛出 NullPointerException。

如果 off 为负，或 len 为负，或 off+len 大于数组 b 的长度，则抛出 IndexOutOfBoundsException。

如果 len 为 0，则没有字节可读且返回 0；否则，要尝试读取至少一个字节。如果因为流位于文件末尾而没有可用的字节，则返回值 -1；否则，至少可以读取一个字节并将其存储在 b 中。

将读取的第一个字节存储在元素 b[off] 中，下一个存储在 b[off+1] 中，依次类推。读取的字节数最多等于 len。让 k 为实际读取的字节数；这些字节将存储在元素 b[off] 至 b[off+k-1] 之间，其余元素 b[off+k] 至 b[off+len-1] 不受影响。

在任何情况下，元素 b[0] 至 b[off] 和元素 b[off+len] 至 b[b.length-1] 都不会受到影响。

如果不是因为流位于文件末尾而无法读取第一个字节，则抛出 IOException。特别是，如果输入流已关闭，则抛出 IOException。

类 InputStream 的 read(b, off, len) 方法只重复调用方法 read()。如果第一个这样的调用导致 IOException，则从对 read(b, off, len) 方法的调用中返回该异常。如果对 read() 的任何后续调用导致 IOException，则该异常会被捕获并将发生异常时的位置视为文件的末尾；到达该点时读取的字节存储在 b 中并返回发生异常之前读取的字节数。建议让子类提供此方法的更有效的实现。

参数：
b - 读入数据的缓冲区。
off - 在其处写入数据的数组 b 的初始偏移量。
len - 要读取的最大字节数。
返回：
读入缓冲区的总字节数，如果由于已到达流末尾而不再有数据，则返回 -1。
抛出：
IOException - 如果发生 I/O 错误。
NullPointerException - 如果 b 为 null。
另请参见：
read()

skip

public long skip(long n)
          throws IOException
跳过和放弃此输入流中的 n 个数据字节。出于各种原因，该 skip 方法跳过某些较小的字节数（可能是 0）后结束。这可能由多种条件引起；在跳过 n 个字节之前已到达文件的末尾只是其中的一种可能。返回跳过的实际字节数。如果 n 为负，则不跳过任何字节。

InputStream 的 skip 方法创建字节数组，然后重复向其读入，直到读够 n 个字节或已到达流的末尾为止。建议让子类提供此方法的更有效的实现。

参数：
n - 要跳过的字节数。
返回：
跳过的实际字节数。
抛出：
IOException - 如果发生 I/O 错误。

available

public int available()
              throws IOException
返回此输入流方法的下一个调用方可以不受阻塞地从此输入流读取（或跳过）的字节数。下一个调用方可能是同一个线程，也可能是另一个线程。

类 InputStream 的 available 方法总是返回 0。

此方法应该由子类重写。

返回：
可以不受阻塞地从此输入流读取的字节数。
抛出：
IOException - 如果发生 I/O 错误。

close

public void close()
           throws IOException
关闭此输入流并释放与该流关联的所有系统资源。

InputStream 的 close 方法不执行任何操作。

指定者：
接口 Closeable 中的 close
抛出：
IOException - 如果发生 I/O 错误。

mark

public void mark(int readlimit)
在此输入流中标记当前的位置。对 reset 方法的后续调用会在最后标记的位置重新定位此流，以便后续读取重新读取相同的字节。

readlimit 参数告知此输入流在标记位置失效之前允许读取许多字节。

mark 的常规协定是：如果方法 markSupported 返回 true，则输入流总会在调用 mark 之后记住所有读取的字节，并且无论何时调用方法 reset ，都会准备再次提供那些相同的字节。但是，如果在调用 reset 之前可以从流中读取多于 readlimit 的字节，则根本不需要该流记住任何数据。

InputStream 的 mark 方法不执行任何操作。

参数：
readlimit - 在标记位置失效前可以读取字节的最大限制。
另请参见：
reset()

reset

public void reset()
           throws IOException
将此流重新定位到对此输入流最后调用 mark 方法时的位置。

reset 的常规协定是：

  • 如果方法 markSupported 返回 true，则：
    • 如果创建流以来未调用方法 mark，或最后调用 mark 以来从该流读取的字节数大于最后调用 mark 时的参数，则可能抛出 IOException。
    • 如果未抛出这样的 IOException，则将该流重新设置为这种状态：最近调用 mark 以来（或如果未调用 mark，则从文件开始以来）读取的所有字节将重新提供给 read 方法的后续调用方，后接可能是调用 reset 时的下一输入数据的所有字节。
  • 如果方法 markSupported 返回 false，则：
    • 对 reset 的调用可能抛出 IOException。
    • 如果未抛出 IOException，则将该流重新设置为一种固定状态，该状态取决于输入流的特定类型和其创建方式的固定状态。提供给 read 方法的后续调用方的字节取决于特定类型的输入流。

除了抛出 IOException 之外，类 InputStream 的方法 reset 不执行任何操作。

抛出：
IOException - 如果未标记此流或该标记失效。
另请参见：
mark(int), IOException

markSupported

public boolean markSupported()
测试此输入流是否支持 mark 和 reset 方法。无论是否支持 mark 和 reset 都是特定输入流实例的不变属性。InputStream 的 markSupported 方法返回 false。

返回：
如果此输入流实例支持 mark 和 reset 方法，则返回 true；否则返回 false。
另请参见：
mark(int), reset()
概述  软件包   类  使用  树  已过时  索引  帮助 
JavaTM 2 Platform
Standard Ed. 5.0
 上一个类   下一个类 框架    无框架    
摘要： 嵌套 | 字段 | 构造方法 | 方法 详细信息： 字段 | 构造方法 | 方法
提交错误或意见
有关更多的 API 参考资料和开发人员文档，请参阅 Java 2 SDK SE 开发人员文档。该文档包含更详细的、面向开发人员的描述，以及总体概述、术语定义、使用技巧和工作代码示例。

版权所有 2004 Sun Microsystems, Inc. 保留所有权利。 请遵守许可证条款。另请参阅文档重新分发政策。