org.apache.hadoop.hbase.io

Class ByteBufferOutputStream

java.lang.Object

java.io.OutputStream

org.apache.hadoop.hbase.io.ByteBufferOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable, ByteBufferWriter

Direct Known Subclasses:

ByteBufferListOutputStream

@InterfaceAudience.Public
public class ByteBufferOutputStream
extends OutputStream
implements ByteBufferWriter

Not thread safe!

Field Summary

Fields

Modifier and Type	Field and Description
protected ByteBuffer	curBuf

Constructor Summary

Constructors

Constructor and Description
ByteBufferOutputStream(ByteBuffer bb)
ByteBufferOutputStream(int capacity)
ByteBufferOutputStream(int capacity, boolean useDirectByteBuffer)

Method Summary

Modifier and Type	Method and Description
protected void	checkSizeAndGrow(int extra)
void	close()
void	flush()
ByteBuffer	getByteBuffer() This flips the underlying BB so be sure to use it _last_!
int	size()
byte[]	toByteArray(int offset, int length)
void	write(byte[] b)
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	write(int b)
void	writeInt(int i) Writes an int to the underlying output stream as four bytes, high byte first.
void	writeTo(OutputStream out) Writes the complete contents of this byte buffer output stream to the specified output stream argument.

Methods inherited from class java.lang.Object

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

Field Detail

curBuf

protected ByteBuffer curBuf

Constructor Detail

ByteBufferOutputStream

public ByteBufferOutputStream(int capacity)

ByteBufferOutputStream

public ByteBufferOutputStream(int capacity,
                              boolean useDirectByteBuffer)

ByteBufferOutputStream

public ByteBufferOutputStream(ByteBuffer bb)

Parameters:

bb - ByteBuffer to use. If too small, will be discarded and a new one allocated in its place; i.e. the passed in BB may NOT BE RETURNED!! Minimally it will be altered. SIDE EFFECT!! If you want to get the newly allocated ByteBuffer, you'll need to pick it up when done with this instance by calling getByteBuffer(). All this encapsulation violation is so we can recycle buffers rather than allocate each time; it can get expensive especially if the buffers are big doing allocations each time or having them undergo resizing because initial allocation was small.

See Also:

getByteBuffer()

Method Detail

size

public int size()

getByteBuffer

public ByteBuffer getByteBuffer()

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

Returns:

ByteBuffer

checkSizeAndGrow

protected void checkSizeAndGrow(int extra)

write

public void write(int b)
           throws IOException

Specified by:

write in class OutputStream

Throws:

IOException

writeTo

public void writeTo(OutputStream out)
             throws IOException

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

Parameters:

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

Throws:

IOException - if an I/O error occurs.

write

public void write(byte[] b)
           throws IOException

Overrides:

write in class OutputStream

Throws:

IOException

write

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

Overrides:

write in class OutputStream

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

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.

writeInt

public void writeInt(int i)
              throws IOException

Writes an int to the underlying output stream as four bytes, high byte first.

Specified by:

writeInt in interface ByteBufferWriter

Parameters:

i - the int to write

Throws:

IOException - if an I/O error occurs.

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Overrides:

flush in class OutputStream

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class OutputStream

Throws:

IOException

toByteArray

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