de.unkrig.commons.io.pipe

Class AbstractRingBuffer

java.lang.Object

de.unkrig.commons.io.pipe.AbstractPipe

de.unkrig.commons.io.pipe.AbstractRingBuffer

All Implemented Interfaces:

Pipe, java.io.Closeable, java.lang.AutoCloseable

public abstract class AbstractRingBuffer
extends AbstractPipe

Abstract implementation of a Pipe by a "backing store" of bytes with fixed size (the "capacity").

Implementation must implement methods get(long, byte[], int, int) and put(byte[], int, int, long) to provide access to the backing store.

Constructor Summary

Constructors

Constructor and Description
AbstractRingBuffer(long capacity)

Method Summary

Modifier and Type	Method and Description
protected abstract void	get(long pos, byte[] buf, int off, int len) Transfers len bytes from the backing store to buf[off]....
boolean	isEmpty()
boolean	isFull()
protected abstract void	put(byte[] buf, int off, int len, long pos) Transfers len bytes from buf[off]... to the backing store.
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, int off, int len) Writes at most len bytes from buf at offset off to this pipe.

Methods inherited from class de.unkrig.commons.io.pipe.AbstractPipe

finalize, read, write

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.unkrig.commons.io.pipe.Pipe

close

Constructor Detail

AbstractRingBuffer

public AbstractRingBuffer(long capacity)

Parameters:

capacity - The size of the backing store

Method Detail

get

protected abstract void get(long pos,
                            byte[] buf,
                            int off,
                            int len)
                     throws java.io.IOException

Transfers len bytes from the backing store to buf[off]....

Parameters:

pos - 0...capacity

off - 0...buf.length

len - 0...min(capacity - pos, buf.length - off

Throws:

java.io.IOException

See Also:

AbstractRingBuffer(long)

put

protected abstract void put(byte[] buf,
                            int off,
                            int len,
                            long pos)
                     throws java.io.IOException

Transfers len bytes from buf[off]... to the backing store.

Parameters:

off - 0...buf.length

len - 0...min(capacity - pos, buf.length - off

pos - 0...capacity

Throws:

java.io.IOException

See Also:

AbstractRingBuffer(long)

read

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

Description copied from interface: Pipe

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.io.IOException

write

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

Description copied from interface: Pipe

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.io.IOException

isEmpty

public final boolean isEmpty()

Returns:

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

isFull

public final boolean isFull()

Returns:

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