org.agrona.io

Class DirectBufferInputStream

java.lang.Object

java.io.InputStream

org.agrona.io.DirectBufferInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class DirectBufferInputStream
extends InputStream

An InputStream that wraps a DirectBuffer.

Constructor Summary

Constructors

Constructor and Description
DirectBufferInputStream() Default constructor.
DirectBufferInputStream(DirectBuffer buffer) Wrap given DirectBuffer.
DirectBufferInputStream(DirectBuffer buffer, int offset, int length) Wrap given DirectBuffer.

Method Summary

Modifier and Type	Method and Description
int	available()
DirectBuffer	buffer() The underlying buffer being wrapped.
void	close()
int	length() The length of the underlying buffer to use
boolean	markSupported()
int	offset() The offset within the underlying buffer at which to start.
int	read()
int	read(byte[] dstBytes, int dstOffset, int length)
long	skip(long n)
void	wrap(DirectBuffer buffer) Wrap given DirectBuffer.
void	wrap(DirectBuffer buffer, int offset, int length) Wrap given DirectBuffer.

Methods inherited from class java.io.InputStream

mark, read, reset

Methods inherited from class java.lang.Object

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

Constructor Detail

DirectBufferInputStream

public DirectBufferInputStream()

Default constructor.

DirectBufferInputStream

public DirectBufferInputStream(DirectBuffer buffer)

Wrap given DirectBuffer.

Parameters:

buffer - to wrap.

DirectBufferInputStream

public DirectBufferInputStream(DirectBuffer buffer,
                               int offset,
                               int length)

Wrap given DirectBuffer.

Parameters:

buffer - to wrap.

offset - into the buffer.

length - in bytes.

Method Detail

wrap

public void wrap(DirectBuffer buffer)

Wrap given DirectBuffer.

Parameters:

buffer - to wrap.

wrap

public void wrap(DirectBuffer buffer,
                 int offset,
                 int length)

Wrap given DirectBuffer.

Parameters:

buffer - to wrap.

offset - into the buffer.

length - in bytes.

offset

public int offset()

The offset within the underlying buffer at which to start.

Returns:

offset within the underlying buffer at which to start.

length

public int length()

The length of the underlying buffer to use

Returns:

length of the underlying buffer to use

buffer

public DirectBuffer buffer()

The underlying buffer being wrapped.

Returns:

the underlying buffer being wrapped.

markSupported

public boolean markSupported()

Overrides:

markSupported in class InputStream

available

public int available()

Overrides:

available in class InputStream

skip

public long skip(long n)

Overrides:

skip in class InputStream

read

public int read()

Specified by:

read in class InputStream

read

public int read(byte[] dstBytes,
                int dstOffset,
                int length)

Overrides:

read in class InputStream

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class InputStream