org.agrona.io

Class DirectBufferInputStream

java.lang.Object

java.io.InputStream

org.agrona.io.DirectBufferInputStream

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class DirectBufferInputStream
extends java.io.InputStream

An InputStream that wraps a DirectBuffer.

Constructor Summary

Constructors

Constructor and Description
DirectBufferInputStream()
DirectBufferInputStream(DirectBuffer buffer)
DirectBufferInputStream(DirectBuffer buffer, int offset, int length)

Method Summary

Modifier and Type	Method and Description
int	available()
DirectBuffer	buffer() The underlying buffer being wrapped.
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)
void	wrap(DirectBuffer buffer, int offset, int length)

Methods inherited from class java.io.InputStream

close, 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()

DirectBufferInputStream

public DirectBufferInputStream(DirectBuffer buffer)

DirectBufferInputStream

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

Method Detail

wrap

public void wrap(DirectBuffer buffer)

wrap

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

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 java.io.InputStream

available

public int available()
              throws java.io.IOException

Overrides:

available in class java.io.InputStream

Throws:

java.io.IOException

skip

public long skip(long n)
          throws java.io.IOException

Overrides:

skip in class java.io.InputStream

Throws:

java.io.IOException

read

public int read()
         throws java.io.IOException

Specified by:

read in class java.io.InputStream

Throws:

java.io.IOException

read

public int read(byte[] dstBytes,
                int dstOffset,
                int length)
         throws java.io.IOException

Overrides:

read in class java.io.InputStream

Throws:

java.io.IOException