compact1, compact2, compact3

java.io

Class InputStream

java.lang.Object

java.io.InputStream

All Implemented Interfaces:

Closeable ， AutoCloseable

已知直接子类：

AudioInputStream ， ByteArrayInputStream ， FileInputStream ， FilterInputStream ， InputStream ， ObjectInputStream ， PipedInputStream ， SequenceInputStream ， StringBufferInputStream

public abstract class InputStream
extends Object
implements Closeable

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

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

从以下版本开始：

JDK1.0

另请参见：

BufferedInputStream ， ByteArrayInputStream ， DataInputStream ， FilterInputStream ， read() ， OutputStream ， PushbackInputStream

构造方法摘要

构造方法

Constructor and Description
InputStream()

方法摘要

Modifier and Type	Method and Description
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字节数据。

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造方法详细信息

InputStream

public InputStream()

方法详细信息

read

public abstract int read()
                  throws IOException

从输入流读取数据的下一个字节。 值字节被返回作为int范围0至255 。 如果没有字节可用，因为已经到达流的末尾，则返回值-1 。 该方法阻塞直到输入数据可用，检测到流的结尾，或抛出异常。

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

结果

数据的下一个字节，如果达到流的末尾， -1 。

异常

IOException - 如果发生I / O错误。

read

public int read(byte[] b)
         throws IOException

从输入流读取一些字节数，并将它们存储到缓冲区b 。 实际读取的字节数作为整数返回。 该方法阻塞直到输入数据可用，检测到文件结束或抛出异常。

如果b的长度为零，则不会读取字节并返回0 ; 否则，尝试读取至少一个字节。 如果没有字节可用，因为流在文件末尾，则返回值-1 ; 否则，读取至少一个字节并存储到b 。

第一个字节读取存储在元素b[0] ，下一个字节存入b[1]等等。 读取的字节数最多等于b的长度。 令k为实际读取的字节数; 这些字节将存储在元素b[0]至b[ k -1] ，使元素b[ k ]至b[b.length-1]不受影响。

该read(b)用于类方法InputStream具有相同的效果为：

   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个字节，但可以读取较小的数字。 实际读取的字节数作为整数返回。

该方法阻塞直到输入数据可用，检测到文件结束或抛出异常。

如果len为零，则不会读取字节并返回0 ; 否则，尝试读取至少一个字节。 如果没有字节可用，因为流是文件的-1则返回值-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]不受影响。

该read(b, off, len)类方法InputStream简单地调用该方法read()反复。 如果第一个这样的呼叫产生一个IOException ，那个异常从呼叫返回到read(b, off, len)方法。 如果任何后续调用read()导致IOException ，则异常被捕获并被视为文件的结尾; 读取到该点的字节被存储到b ，并且返回异常发生前读取的字节数。 该方法的默认实现将阻塞，直到所请求的输入数据len已被读取，文件结束被检测到或异常被抛出为止。 鼓励子类提供更有效的方法实现。

参数

b - 读取数据的缓冲区。

off - 写入数据的数组 b中的起始偏移量。

len - 要读取的最大字节数。

结果

读取到缓冲区的总字节数，如果没有更多的数据，因为已经到达流的末尾，那么 -1 。

异常

IOException - 如果由于文件结束之外的任何原因，或者输入流已关闭，或者发生其他I / O错误，则无法读取第一个字节。

NullPointerException - 如果 b是 null 。

IndexOutOfBoundsException - 如果 off为负数， len为负数，或 len大于 b.length - off

另请参见：

read()

skip

public long skip(long n)
          throws IOException

跳过并丢弃来自此输入流的n字节数据。 由于各种原因， skip方法可能会跳过一些较小数量的字节，可能是0 。 这可能是由许多条件中的任何一个引起的 n字节之前已经跳过的文件到达结束只有一种可能。 返回实际跳过的字节数。 如果n是否定的，则skip类方法InputStream总是返回0，并且没有字节被跳过。 子类可以不同地处理负值。

skip方法创建一个字节数组，然后重复读入它，直到已读取n个字节或已达到流的结尾。 鼓励子类提供更有效的方法实现。 例如，实施可能取决于寻求的能力。

参数

n - 要跳过的字节数。

结果

实际跳过的字节数。

异常

IOException - 如果流不支持查询，或者发生其他I / O错误。

available

public int available()
              throws IOException

返回从该输入流中可以读取（或跳过）的字节数的估计值，而不会被下一次调用此输入流的方法阻塞。 下一个调用可能是同一个线程或另一个线程。 这个多个字节的单个读取或跳过将不会被阻塞，但可以读取或跳过较少的字节。

注意，尽管一些实现InputStream将在流中返回的字节总数，许多人不会。 使用此方法的返回值分配用于保存此流中的所有数据的缓冲区是绝对不正确的。

子类此方法的实现可以选择抛出IOException如果输入流已通过调用关闭close()方法。

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

这个方法应该被子类覆盖。

结果

当输入流到达输入流的末尾时，可以从该输入流中读取（或跳过）的字节数，而不阻塞的字节数 0 。

异常

IOException - 如果发生I / O错误。

close

public void close()
           throws IOException

关闭此输入流并释放与流相关联的任何系统资源。

该close的方法InputStream什么都不做。

Specified by:

close在接口 Closeable

Specified by:

close在接口 AutoCloseable

异常

IOException - 如果发生I / O错误。

mark

public void mark(int readlimit)

标记此输入流中的当前位置。 对reset方法的后续调用会将该流重新定位在最后一个标记的位置，以便后续读取重新读取相同的字节。

readlimit参数告诉这个输入流，以允许在标记位置无效之前读取许多字节。

的总承包mark是，如果该方法markSupported返回true ，流莫名其妙地记得电话后读取到所有字节mark ，并随时准备再次提供那些相同的字节，如果每当方法reset被调用。 但是，如果在reset之前从流中读取超过readlimit个字节，则流不需要记住任何数据。

标记封闭的流对流不应有任何影响。

该mark的方法InputStream什么都不做。

参数

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方法的后续调用者的read取决于输入流的特定类型。

该方法reset类InputStream什么也不做只是抛出一个IOException 。

异常

IOException - 如果该流未被标记或标记已被无效。

另请参见：

mark(int) ， IOException

markSupported

public boolean markSupported()

测试这个输入流是否支持mark和reset方法。 是否mark和reset是特定输入流实例的不变属性。 该markSupported的方法InputStream返回false 。

结果

true如果这个流实例支持标记和重置方法; false否则。

另请参见：

mark(int) ， reset()