io.pravega.common.io

Class FixedByteArrayOutputStream

java.lang.Object

java.io.OutputStream

io.pravega.common.io.FixedByteArrayOutputStream

All Implemented Interfaces:

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

public class FixedByteArrayOutputStream
extends java.io.OutputStream
implements RandomAccessOutputStream

OutputStream that writes to a fixed-size buffer (this is needed because ByteArrayOutputStream auto-grows the buffer).

Constructor Summary

Constructors

Constructor and Description
FixedByteArrayOutputStream(byte[] array, int offset, int length) Creates a new instance of the FixedByteArrayOutputStream class.

Method Summary

Modifier and Type	Method and Description
void	close()
ByteArraySegment	getData() Returns a readonly ByteArraySegment wrapping this Stream's buffer.
int	size() Gets a value indicating the size of this OutputStream.
java.io.OutputStream	subStream(int streamPosition, int length) Creates a new fixed-size OutputStream starting at the given position in this OutputStream and of the given length.
void	write(byte[] buffer, int bufferOffset, int length, int streamPosition) Writes a sequence of bytes at the given position.
void	write(int b)
void	write(int byteValue, int streamPosition) Writes the given byte value at the given position.

Methods inherited from class java.io.OutputStream

flush, write, write

Methods inherited from class java.lang.Object

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

Constructor Detail

FixedByteArrayOutputStream

public FixedByteArrayOutputStream(byte[] array,
                                  int offset,
                                  int length)

Creates a new instance of the FixedByteArrayOutputStream class.

Parameters:

array - The array to wrap.

offset - The offset to start the OutputStream at.

length - The maximum length of the OutputStream.

Throws:

java.lang.NullPointerException - If array is null.

java.lang.ArrayIndexOutOfBoundsException - If offset and/or length are invalid.

Method Detail

write

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

Specified by:

write in class java.io.OutputStream

Throws:

java.io.IOException

write

public void write(int byteValue,
                  int streamPosition)
           throws java.io.IOException

Description copied from interface: RandomAccessOutputStream

Writes the given byte value at the given position.

Specified by:

write in interface RandomAccessOutputStream

Parameters:

byteValue - The value to write.

streamPosition - The position to write at.

Throws:

java.io.IOException - If an IO Exception occurred.

write

public void write(byte[] buffer,
                  int bufferOffset,
                  int length,
                  int streamPosition)
           throws java.io.IOException

Description copied from interface: RandomAccessOutputStream

Writes a sequence of bytes at the given position. NOTE: depending on the implementation of this interface, this may result in increasing the size of the stream. For example, if position is smaller than size() AND position + length is larger than size() then the extra bytes may be appended at the end, if the underlying OutputStream's structure permits it.

Specified by:

write in interface RandomAccessOutputStream

Parameters:

buffer - The buffer to write from.

bufferOffset - The offset within the buffer to start at.

length - The number of bytes to write.

streamPosition - The position within the OutputStream to write at.

Throws:

java.io.IOException - If an IO Exception occurred.

subStream

public java.io.OutputStream subStream(int streamPosition,
                                      int length)

Description copied from interface: RandomAccessOutputStream

Creates a new fixed-size OutputStream starting at the given position in this OutputStream and of the given length.

Specified by:

subStream in interface RandomAccessOutputStream

Parameters:

streamPosition - The position to start at.

length - The length of the OutputStream.

Returns:

A new OutputStream.

size

public int size()

Description copied from interface: RandomAccessOutputStream

Gets a value indicating the size of this OutputStream.

Specified by:

size in interface RandomAccessOutputStream

getData

public ByteArraySegment getData()

Returns a readonly ByteArraySegment wrapping this Stream's buffer.

Returns:

A readonly ByteArraySegment from the current buffer.

close

public void close()

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class java.io.OutputStream