|
|||||||||
摘要: 嵌套 | 字段 | 构造方法 | 方法 | 详细信息: 字段 | 构造方法 | 方法 |
java.io
类 InputStream
java.lang.Object java.io.InputStream
- 所有已实现的接口:
- Closeable
- 直接已知子类:
- AudioInputStream, ByteArrayInputStream, FileInputStream, FilterInputStream, InputStream, ObjectInputStream, PipedInputStream, SequenceInputStream, StringBufferInputStream
此抽象类是表示字节输入流的所有类的超类。
需要定义 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
方法不执行任何操作。 -
- 抛出:
-
IOException
- 如果发生 I/O 错误。
mark
public void mark(int readlimit)
-
在此输入流中标记当前的位置。对
reset
方法的后续调用会在最后标记的位置重新定位此流,以便后续读取重新读取相同的字节。readlimit
参数告知此输入流在标记位置失效之前允许读取许多字节。mark
的常规协定是:如果方法markSupported
返回true
,则输入流总会在调用mark
之后记住所有读取的字节,并且无论何时调用方法reset
,都会准备再次提供那些相同的字节。但是,如果在调用reset
之前可以从流中读取多于readlimit
的字节,则根本不需要该流记住任何数据。InputStream
的mark
方法不执行任何操作。 -
-
- 参数:
-
readlimit
- 在标记位置失效前可以读取字节的最大限制。 - 另请参见:
-
reset()