org.apache.hadoop.hbase.io

Class ByteBufferListOutputStream

java.lang.Object

java.io.OutputStream

org.apache.hadoop.hbase.io.ByteBufferOutputStream

org.apache.hadoop.hbase.io.ByteBufferListOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable, ByteBufferWriter

@InterfaceAudience.Private
public class ByteBufferListOutputStream
extends ByteBufferOutputStream

An OutputStream which writes data into ByteBuffers. It will try to get ByteBuffer, as and when needed, from the passed pool. When pool is not giving a ByteBuffer it will create one on heap. Make sure to call releaseResources() method once the Stream usage is over and data is transferred to the wanted destination. Not thread safe!

Field Summary

Fields

Modifier and Type	Field and Description
protected List<ByteBuffer>	allBufs
protected List<ByteBuffer>	bufsFromPool
private boolean	lastBufFlipped
private static org.slf4j.Logger	LOG
private ByteBufferPool	pool

Fields inherited from class org.apache.hadoop.hbase.io.ByteBufferOutputStream

curBuf

Constructor Summary

Constructors

Constructor and Description
ByteBufferListOutputStream(ByteBufferPool pool)

Method Summary

Modifier and Type	Method and Description
private void	allocateNewBuffer()
protected void	checkSizeAndGrow(int extra)
ByteBuffer	getByteBuffer() This flips the underlying BB so be sure to use it _last_!
List<ByteBuffer>	getByteBuffers() We can be assured that the buffers returned by this method are all flipped
void	releaseResources() Release the resources it uses (The ByteBuffers) which are obtained from pool.
int	size()
byte[]	toByteArray(int offset, int length)
void	write(byte[] b, int off, int len)
void	write(ByteBuffer b, int off, int len) Writes len bytes from the specified ByteBuffer starting at offset off
void	writeTo(OutputStream out) Writes the complete contents of this byte buffer output stream to the specified output stream argument.

Methods inherited from class org.apache.hadoop.hbase.io.ByteBufferOutputStream

close, flush, write, write, writeInt

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final org.slf4j.Logger LOG

pool

private ByteBufferPool pool

allBufs

protected List<ByteBuffer> allBufs

bufsFromPool

protected List<ByteBuffer> bufsFromPool

lastBufFlipped

private boolean lastBufFlipped

Constructor Detail

ByteBufferListOutputStream

public ByteBufferListOutputStream(ByteBufferPool pool)

Method Detail

allocateNewBuffer

private void allocateNewBuffer()

size

public int size()

Overrides:

size in class ByteBufferOutputStream

getByteBuffer

public ByteBuffer getByteBuffer()

Description copied from class: ByteBufferOutputStream

This flips the underlying BB so be sure to use it _last_!

Overrides:

getByteBuffer in class ByteBufferOutputStream

Returns:

ByteBuffer

checkSizeAndGrow

protected void checkSizeAndGrow(int extra)

Overrides:

checkSizeAndGrow in class ByteBufferOutputStream

writeTo

public void writeTo(OutputStream out)
             throws IOException

Description copied from class: ByteBufferOutputStream

Writes the complete contents of this byte buffer output stream to the specified output stream argument.

Overrides:

writeTo in class ByteBufferOutputStream

Parameters:

out - the output stream to which to write the data.

Throws:

IOException - if an I/O error occurs.

releaseResources

public void releaseResources()

Release the resources it uses (The ByteBuffers) which are obtained from pool. Call this only when all the data is fully used. And it must be called at the end of usage else we will leak ByteBuffers from pool.

toByteArray

public byte[] toByteArray(int offset,
                          int length)

Overrides:

toByteArray in class ByteBufferOutputStream

getByteBuffers

public List<ByteBuffer> getByteBuffers()

We can be assured that the buffers returned by this method are all flipped

Returns:

list of bytebuffers

write

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

Overrides:

write in class ByteBufferOutputStream

Throws:

IOException

write

public void write(ByteBuffer b,
                  int off,
                  int len)
           throws IOException

Description copied from interface: ByteBufferWriter

Writes len bytes from the specified ByteBuffer starting at offset off

Specified by:

write in interface ByteBufferWriter

Overrides:

write in class ByteBufferOutputStream

Parameters:

b - the data.

off - the start offset in the data.

len - the number of bytes to write.

Throws:

IOException - if an I/O error occurs.