io.pravega.common.io

Class EnhancedByteArrayOutputStream

java.lang.Object

java.io.OutputStream

java.io.ByteArrayOutputStream

io.pravega.common.io.EnhancedByteArrayOutputStream

All Implemented Interfaces:

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

public class EnhancedByteArrayOutputStream
extends java.io.ByteArrayOutputStream
implements RandomAccessOutputStream

A ByteArrayOutputStream that exposes the contents as a ByteArraySegment, without requiring a memory copy.

Field Summary

Fields inherited from class java.io.ByteArrayOutputStream

buf, count

Constructor Summary

Constructors

Constructor and Description
EnhancedByteArrayOutputStream()

Method Summary

Modifier and Type	Method and Description
ByteArraySegment	getData() Returns a readonly ByteArraySegment wrapping the current buffer of the ByteArrayOutputStream.
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[] array)
void	write(byte[] buffer, int bufferOffset, int length, int streamPosition) Writes a sequence of bytes at the given position.
void	write(int byteValue, int streamPosition) Writes the given byte value at the given position.

Methods inherited from class java.io.ByteArrayOutputStream

close, reset, size, toByteArray, toString, toString, toString, write, write, writeTo

Methods inherited from class java.io.OutputStream

flush

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.pravega.common.io.serialization.RandomAccessOutputStream

size

Constructor Detail

EnhancedByteArrayOutputStream

public EnhancedByteArrayOutputStream()

Method Detail

getData

public ByteArraySegment getData()

Returns a readonly ByteArraySegment wrapping the current buffer of the ByteArrayOutputStream.

Returns:

A readonly ByteArraySegment from the current buffer of the ByteArrayOutputStream.

write

public void write(byte[] array)

Overrides:

write in class java.io.OutputStream

write

public void write(int byteValue,
                  int streamPosition)

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.

write

public void write(byte[] buffer,
                  int bufferOffset,
                  int length,
                  int streamPosition)

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.

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.