compact1, compact2, compact3

java.io

Class PipedInputStream

java.lang.Object

java.io.InputStream

java.io.PipedInputStream

All Implemented Interfaces:

Closeable， AutoCloseable

public class PipedInputStream
extends InputStream

一个管道输入流应该连接到一个管道输出流，管道输入流，然后提供任何数据字节写入到管道输出流。通常情况下，数据是由一个线程和数据从一个 PipedInputStream对象读取是由其他线程对应的 PipedOutputStream写。试图从一个线程中使用这两个对象是不推荐的，因为它可能会死锁线程。管道输入流包含一个缓冲区，从写操作中读取操作，在限制范围内。管是 broken 如果一个线程是连接管道输出流提供数据字节不再活着。

从以下版本开始：

JDK1.0

另请参见：

PipedOutputStream

Field Summary

Fields

Modifier and Type	Field and Description
protected byte[]	buffer 放置传入数据的循环缓冲区。
protected int	in 在循环缓冲区中的下一个字节的数据将被存储时，从连接的管道输出流中的位置的索引。
protected int	out 在循环缓冲区中的下一个字节的数据将由这个管道输入流读取的索引。
protected static int	PIPE_SIZE 管道的循环输入缓冲区的默认大小。

构造方法摘要

构造方法

Constructor and Description
PipedInputStream() 创建一个 PipedInputStream因此没有 connected。
PipedInputStream(int pipeSize) 创建一个 PipedInputStream因此没有 connected并使用指定的管道尺寸的管的缓冲。
PipedInputStream(PipedOutputStream src) 创建一个 PipedInputStream使它连接到管道输出流 src。
PipedInputStream(PipedOutputStream src, int pipeSize) 创建一个 PipedInputStream使它连接到管道输出流 src并使用指定的管道尺寸的管的缓冲。

方法摘要

Modifier and Type	Method and Description
int	available() 返回可以从这个输入流中读取的字节数，而不阻塞。
void	close() 关闭此管道输入流并释放与流关联的任何系统资源。
void	connect(PipedOutputStream src) 造成这一管道输入流被连接到管道输出流 src。
int	read() 从这个管道输入流读取下一个数据字节。
int	read(byte[] b, int off, int len) 读到 len从这个管道输入流转换成字节数组数据字节。
protected void	receive(int b) 接收一个字节的数据。

Methods inherited from class java.io.InputStream

mark, markSupported, read, reset, skip

Methods inherited from class java.lang.Object

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

Field Detail

PIPE_SIZE

protected static final int PIPE_SIZE

管道的循环输入缓冲区的默认大小。

从以下版本开始：

JDK1.1

另请参见：

Constant Field Values

buffer

protected byte[] buffer

放置传入数据的循环缓冲区。

从以下版本开始：

JDK1.1

in

protected int in

在循环缓冲区中的下一个字节的数据将被存储时，从连接的管道输出流中的位置的索引。 in<0意味着缓冲区是空的， in==out意味着缓冲区满

从以下版本开始：

JDK1.1

out

protected int out

在循环缓冲区中的下一个字节的数据将由这个管道输入流读取的索引。

从以下版本开始：

JDK1.1

Constructor Detail

PipedInputStream

public PipedInputStream(PipedOutputStream src)
                 throws IOException

创建一个 PipedInputStream使它连接到管道输出流 src。写 src字节的数据就可以从这流输入。

参数

src流-连接。

异常

IOException如果I/O错误发生。

PipedInputStream

public PipedInputStream(PipedOutputStream src,
                        int pipeSize)
                 throws IOException

创建一个 PipedInputStream使它连接到管道输出流 src并使用指定的管道尺寸的管的缓冲。写 src字节的数据就可以从这流输入。

参数

src流-连接。

pipeSize -管道的缓冲区的大小。

异常

IOException如果I/O错误发生。

如果 pipeSize <= 0 IllegalArgumentException。

从以下版本开始：

一点六

PipedInputStream

public PipedInputStream()

创建一个 PipedInputStream因此没有 connected。它必须是一个 PipedOutputStream connected使用前。

PipedInputStream

public PipedInputStream(int pipeSize)

创建一个 PipedInputStream因此没有 connected并使用指定的管道尺寸的管的缓冲。它必须是一个 PipedOutputStream connected使用前。

参数

pipeSize -管道的缓冲区的大小。

异常

如果 pipeSize <= 0 IllegalArgumentException。

从以下版本开始：

一点六

方法详细信息

connect

public void connect(PipedOutputStream src)
             throws IOException

造成这一管道输入流被连接到管道输出流 src。如果这个对象已经连接到其他管道输出流，一个 IOException抛出。

如果src是悬空管道输出流，snk是无关的管道输入流，他们可以通过电话连接：

snk.connect(src)

或呼叫：

src.connect(snk)

这两个电话有相同的效果。

参数

src -管道输出流连接。

异常

IOException如果I/O错误发生。

receive

protected void receive(int b)
                throws IOException

接收一个字节的数据。如果没有可用的输入，该方法将阻塞。

参数

b收到的字节

异常

IOException如果管 broken， unconnected，关闭，或者如果一个I/O错误发生。

从以下版本开始：

JDK1.1

read

public int read()
         throws IOException

从这个管道输入流读取下一个数据字节。字节的值在范围 0一 int到 255返回。此方法块，直到输入数据可用，流的结束被检测到，或抛出异常。

Specified by:

read 方法重写，继承类 InputStream

结果

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

异常

IOException如果管 unconnected， broken，关闭，或者如果一个I/O错误发生。

read

public int read(byte[] b,
                int off,
                int len)
         throws IOException

读到 len从这个管道输入流转换成字节数组数据字节。小于 len字节将如果数据到达流的末尾或者 len超过管道的缓冲区大小的读。如果 len 是零，那么没有字节读取和返回0；否则，该方法将阻塞直到至少1字节输入流是可用的，最终被发现，或者抛出一个异常。

重写：

read 方法重写，继承类 InputStream

参数

b -缓冲区中读取数据。

off -开始抵消目标数组 b

len -的最大字节数读。

结果

读入缓冲的字节总数，或 -1如果没有更多的数据，因为已到达流的末尾。

异常

如果是 null b NullPointerException。

IndexOutOfBoundsException -如果 off是负的， len是负的，或 len大于 b.length - off

IOException如果管 broken， unconnected，关闭，或者如果一个I/O错误发生。

另请参见：

InputStream.read()

available

public int available()
              throws IOException

返回可以从这个输入流中读取的字节数，而不阻塞。

重写：

available 方法重写，继承类 InputStream

结果

字节可以从输入流中非阻塞读数，或 0如果输入流被调用其 close()方法关闭，或者如果管 unconnected，或 broken。

异常

IOException如果I/O错误发生。

从以下版本开始：

jdk1.0.2

close

public void close()
           throws IOException

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

Specified by:

close 接口 Closeable

Specified by:

close 接口 AutoCloseable

重写：

close 方法重写，继承类 InputStream

异常

IOException如果I/O错误发生。