Package io.pravega.common.util

Class AbstractBufferView.AbstractReader

java.lang.Object

io.pravega.common.util.AbstractBufferView.AbstractReader

All Implemented Interfaces:

BufferView.Reader

Enclosing class:

AbstractBufferView

protected abstract static class AbstractBufferView.AbstractReader
extends java.lang.Object
implements BufferView.Reader

Base implementation of BufferView.Reader. Subclasses of AbstractBufferView should implement their own BufferView.Reader instances based on this class.

Nested Class Summary

Nested classes/interfaces inherited from interface io.pravega.common.util.BufferView.Reader

BufferView.Reader.OutOfBoundsException

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractReader()

Method Summary

Modifier and Type	Method	Description
ArrayView	readFully(int bufferSize)	Copies all the remaining bytes from this BufferView.Reader into a new ArrayView.
int	readInt()	Reads 4 bytes (and advances the reader position by 4) and composes a 32-bit Integer (Big-Endian).
long	readLong()	Reads 8 bytes (and advances the reader position by 4) and composes a 64-bit Long (Big-Endian).

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.pravega.common.util.BufferView.Reader

available, readByte, readBytes, readSlice

Constructor Detail

AbstractReader

protected AbstractReader()

Method Detail

readInt

public int readInt()

Reads 4 bytes (and advances the reader position by 4) and composes a 32-bit Integer (Big-Endian). Default implementation for BufferView.Reader.readInt(). Derived classes should make every effort to override this implementation with one that is as efficient as possible (if the BufferView implementation allows it).

Specified by:

readInt in interface BufferView.Reader

Returns:

The read int.

Throws:

BufferView.Reader.OutOfBoundsException - If BufferView.Reader.available() is less than Integer.BYTES.

readLong

public long readLong()

Reads 8 bytes (and advances the reader position by 4) and composes a 64-bit Long (Big-Endian). Default implementation for BufferView.Reader.readLong(). Derived classes should make every effort to override this implementation with one that is as efficient as possible (if the BufferView implementation allows it).

Specified by:

readLong in interface BufferView.Reader

Returns:

The read int.

Throws:

BufferView.Reader.OutOfBoundsException - If BufferView.Reader.available() is less than Long.BYTES.

readFully

public ArrayView readFully(int bufferSize)

Description copied from interface: BufferView.Reader

Copies all the remaining bytes from this BufferView.Reader into a new ArrayView. The reader position will be set to the end of the BufferView.

Specified by:

readFully in interface BufferView.Reader

Parameters:

bufferSize - The maximum number of bytes to copy at each iteration. Set to Integer.MAX_VALUE to attempt to copy the whole buffer at once.

Returns:

A new ByteArraySegment with the remaining contents of BufferView.Reader.