de.unkrig.commons.io.pipe

Interface Pipe

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable

All Known Implementing Classes:

AbstractPipe, AbstractRingBuffer

public interface Pipe
extends java.io.Closeable

read(byte[], int, int) produces exactly the bytes that were previously written.

Method Summary

Modifier and Type	Method and Description
void	close() Releases any resources allocated for this pipe.
boolean	isEmpty()
boolean	isFull()
int	read(byte[] buf) Reads at most buf.length bytes from this pipe into the buf.
int	read(byte[] buf, int off, int len) Reads at most len bytes from this pipe into the buf at offset off.
int	write(byte[] buf) Writes at most buf.length bytes from buf to this pipe.
int	write(byte[] buf, int off, int len) Writes at most len bytes from buf at offset off to this pipe.

Method Detail

read

int read(byte[] buf)
  throws java.io.IOException

Reads at most buf.length bytes from this pipe into the buf.

Returns:

The number of bytes read (1 ... buf.length); 0 iff this pipe is empty

Throws:

java.io.IOException

read

int read(byte[] buf,
         int off,
         int len)
  throws java.io.IOException

Reads at most len bytes from this pipe into the buf at offset off.

Returns:

The number of bytes read (1 ... len); 0 iff this pipe is empty

Throws:

java.lang.RuntimeException - off is negative

java.lang.RuntimeException - len is negative

java.lang.RuntimeException - off+len is greater than buf.length

java.io.IOException

write

int write(byte[] buf)
   throws java.io.IOException

Writes at most buf.length bytes from buf to this pipe.

Returns:

The number of bytes written (1 ... buf.length); 0 iff this pipe is full

Throws:

java.io.IOException

write

int write(byte[] buf,
          int off,
          int len)
   throws java.io.IOException

Writes at most len bytes from buf at offset off to this pipe.

Returns:

The number of bytes written (1 ... len); 0 iff this pipe is full

Throws:

java.lang.RuntimeException - off is negative

java.lang.RuntimeException - len is negative

java.lang.RuntimeException - off+len is greater than buf.length

java.io.IOException

close

void close()
    throws java.io.IOException

Releases any resources allocated for this pipe. The results of subsequent invocations of read(byte[], int, int) and write(byte[], int, int) are undefined.

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

Throws:

java.io.IOException

isFull

boolean isFull()

Returns:

Whether the next invocation of write(byte[], int, int) will return 0

isEmpty

boolean isEmpty()

Returns:

Whether the next invocation of read(byte[], int, int) will return 0