org.apache.hadoop.hbase.io

Class ByteBufferOutputStream

java.lang.Object

java.io.OutputStream

org.apache.hadoop.hbase.io.ByteBufferOutputStream

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable

@InterfaceAudience.Public
 @InterfaceStability.Evolving
public class ByteBufferOutputStream
extends java.io.OutputStream

Not thread safe!

Field Summary

Fields

Modifier and Type	Field and Description
protected java.nio.ByteBuffer	buf

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	close()
void	flush()
java.nio.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(int b)
void	writeTo(java.io.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

buf

protected java.nio.ByteBuffer buf

Constructor Detail

ByteBufferOutputStream

public ByteBufferOutputStream(int capacity)

ByteBufferOutputStream

public ByteBufferOutputStream(int capacity,
                              boolean useDirectByteBuffer)

ByteBufferOutputStream

public ByteBufferOutputStream(java.nio.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 java.nio.ByteBuffer getByteBuffer()

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

Returns:

ByteBuffer

write

public void write(int b)
           throws java.io.IOException

Specified by:

write in class java.io.OutputStream

Throws:

java.io.IOException

writeTo

public void writeTo(java.io.OutputStream out)
             throws java.io.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:

java.io.IOException - if an I/O error occurs.

write

public void write(byte[] b)
           throws java.io.IOException

Overrides:

write in class java.io.OutputStream

Throws:

java.io.IOException

write

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

Overrides:

write in class java.io.OutputStream

Throws:

java.io.IOException

flush

public void flush()
           throws java.io.IOException

Specified by:

flush in interface java.io.Flushable

Overrides:

flush in class java.io.OutputStream

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class java.io.OutputStream

Throws:

java.io.IOException

toByteArray

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