org.agrona.io

Class ExpandableDirectBufferOutputStream

java.lang.Object

java.io.OutputStream

org.agrona.io.ExpandableDirectBufferOutputStream

All Implemented Interfaces:

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

public class ExpandableDirectBufferOutputStream
extends java.io.OutputStream

OutputStream that wraps an underlying expandable version of a MutableDirectBuffer.

Constructor Summary

Constructors

Constructor and Description
ExpandableDirectBufferOutputStream()
ExpandableDirectBufferOutputStream(MutableDirectBuffer buffer)
ExpandableDirectBufferOutputStream(MutableDirectBuffer buffer, int offset)

Method Summary

Modifier and Type	Method and Description
MutableDirectBuffer	buffer() The underlying buffer being wrapped.
void	close()
int	offset() The offset within the underlying buffer at which to start.
int	position() The position in the buffer from the offset up to which has been written.
void	wrap(MutableDirectBuffer buffer) Wrap a given buffer beginning with an offset of 0.
void	wrap(MutableDirectBuffer buffer, int offset) Wrap a given buffer beginning at an offset.
void	write(byte[] srcBytes, int srcOffset, int length) Write a byte[] to the buffer.
void	write(int b) Write a byte to buffer.

Methods inherited from class java.io.OutputStream

flush, write

Methods inherited from class java.lang.Object

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

Constructor Detail

ExpandableDirectBufferOutputStream

public ExpandableDirectBufferOutputStream()

ExpandableDirectBufferOutputStream

public ExpandableDirectBufferOutputStream(MutableDirectBuffer buffer)

ExpandableDirectBufferOutputStream

public ExpandableDirectBufferOutputStream(MutableDirectBuffer buffer,
                                          int offset)

Method Detail

wrap

public void wrap(MutableDirectBuffer buffer)

Wrap a given buffer beginning with an offset of 0.

Parameters:

buffer - to wrap

wrap

public void wrap(MutableDirectBuffer buffer,
                 int offset)

Wrap a given buffer beginning at an offset.

Parameters:

buffer - to wrap

offset - at which the puts will occur.

position

public int position()

The position in the buffer from the offset up to which has been written.

Returns:

the position in the buffer from the offset up to which has been written.

offset

public int offset()

The offset within the underlying buffer at which to start.

Returns:

offset within the underlying buffer at which to start.

buffer

public MutableDirectBuffer buffer()

The underlying buffer being wrapped.

Returns:

the underlying buffer being wrapped.

write

public void write(int b)

Write a byte to buffer.

Specified by:

write in class java.io.OutputStream

Parameters:

b - to be written.

write

public void write(byte[] srcBytes,
                  int srcOffset,
                  int length)

Write a byte[] to the buffer.

Overrides:

write in class java.io.OutputStream

Parameters:

srcBytes - to write

srcOffset - at which to begin reading bytes from the srcBytes.

length - of the srcBytes to read.

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