Package io.pravega.common.util

Class CompositeByteArraySegment

java.lang.Object

io.pravega.common.util.AbstractBufferView

io.pravega.common.util.CompositeByteArraySegment

All Implemented Interfaces:

BufferView, CompositeArrayView, StructuredWritableBuffer

public class CompositeByteArraySegment
extends AbstractBufferView
implements CompositeArrayView

A composite, index-based array-like structure that is made up of one or more individual arrays of equal size. Each component array maps to a contiguous offset range and is only allocated when the first index within its range needs to be set (if unallocated, any index within its range will have a value of 0).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CompositeByteArraySegment.BufferLayout	Defines the internal layout of a CompositeByteArraySegment.

Nested classes/interfaces inherited from class io.pravega.common.util.AbstractBufferView

AbstractBufferView.AbstractReader

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

BufferView.Collector<ExceptionT extends java.lang.Exception>, BufferView.Reader

Constructor Summary

Constructors

Constructor	Description
CompositeByteArraySegment(@lombok.NonNull byte[] source)	Creates a new instance of the CompositeByteArraySegment class that wraps the given array.
CompositeByteArraySegment(int length)	Creates a new instance of the CompositeByteArraySegment class with a default component array size.
CompositeByteArraySegment(int length, CompositeByteArraySegment.BufferLayout bufferLayout)	Creates a new instance of the CompositeByteArraySegment class with the given component array size.

Method Summary

Modifier and Type	Method	Description
<ExceptionT extends java.lang.Exception> void	collect(BufferView.Collector<ExceptionT> bufferCollector)	Iterates through each of the buffers that make up this BufferView, in order, and invokes the given BufferView.Collector on each.
void	copyFrom(BufferView.Reader source, int targetOffset, int length)	Copies a specified number of bytes from the given BufferView.Reader into this CompositeArrayView.
void	copyTo(java.io.OutputStream target)	Copies the contents of this BufferView to the given OutputStream.
int	copyTo(java.nio.ByteBuffer target)	Copies the contents of this BufferView to the given ByteBuffer.
byte	get(int offset)	Gets the value at the specified index.
int	getAllocatedLength()	Gets a value indicating the amount of memory (in bytes) allocated for this BufferView.
io.pravega.common.util.CompositeByteArraySegment.CompositeReader	getBufferViewReader()	Creates a new BufferView.Reader that can be used to read this BufferView.
int	getComponentCount()	Gets the number of components in this CompositeArrayView instance.
byte[]	getCopy()	Returns a copy of the contents of this BufferView.
int	getLength()	Gets a value representing the length of this BufferView.
java.io.InputStream	getReader()	Creates an InputStream that can be used to read the contents of this BufferView.
java.io.InputStream	getReader(int offset, int length)	Creates an InputStream that can be used to read the contents of this BufferView.
java.util.Iterator<java.nio.ByteBuffer>	iterateBuffers()	Gets an Iterator through each of the ByteBuffers that make up this BufferView, in order.
void	set(int offset, byte value)	Sets the value at the specified index.
void	setInt(int offset, int value)	Sets a 32 bit Integer value at the specified index.
void	setLong(int offset, long value)	Sets a 64 bit Long value at the specified index.
void	setShort(int offset, short value)	Sets a Short value at the specified index.
CompositeArrayView	slice(int offset, int length)	Creates a new CompositeArrayView that represents a sub-range of this CompositeArrayView instance.

Methods inherited from class io.pravega.common.util.AbstractBufferView

equals, equals, hashCode

Methods inherited from class java.lang.Object

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

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

release, retain, slice

Methods inherited from interface io.pravega.common.util.StructuredWritableBuffer

setUnsignedLong

Constructor Detail

CompositeByteArraySegment

public CompositeByteArraySegment(int length)

Creates a new instance of the CompositeByteArraySegment class with a default component array size.

Parameters:

length - The length of the CompositeByteArraySegment. This will determine the number of components to use, but doesn't allocate any of them yet.

CompositeByteArraySegment

public CompositeByteArraySegment(int length,
                                 CompositeByteArraySegment.BufferLayout bufferLayout)

Creates a new instance of the CompositeByteArraySegment class with the given component array size.

Parameters:

length - The length of the CompositeByteArraySegment. This will determine the number of components to use, but doesn't allocate any of them yet.

bufferLayout - The CompositeByteArraySegment.BufferLayout to use.

CompositeByteArraySegment

public CompositeByteArraySegment(@NonNull
                                 @lombok.NonNull byte[] source)

Creates a new instance of the CompositeByteArraySegment class that wraps the given array. This instance will have a single component array.

Parameters:

source - The byte array to wrap. Any changes made to this array will be reflected in this CompositeByteArraySegment instance and vice-versa.

Method Detail

get

public byte get(int offset)

Description copied from interface: CompositeArrayView

Gets the value at the specified index.

Specified by:

get in interface CompositeArrayView

Parameters:

offset - The index to query.

Returns:

Byte indicating the value at the given index.

set

public void set(int offset,
                byte value)

Description copied from interface: StructuredWritableBuffer

Sets the value at the specified index.

Specified by:

set in interface StructuredWritableBuffer

Parameters:

offset - The index to set the value at.

value - The Byte value to set.

setShort

public void setShort(int offset,
                     short value)

Description copied from interface: StructuredWritableBuffer

Sets a Short value at the specified index.

Specified by:

setShort in interface StructuredWritableBuffer

Parameters:

offset - The index to set the value at.

value - The Short value to set.

setInt

public void setInt(int offset,
                   int value)

Description copied from interface: StructuredWritableBuffer

Sets a 32 bit Integer value at the specified index.

Specified by:

setInt in interface StructuredWritableBuffer

Parameters:

offset - The index to set the value at.

value - The Integer value to set.

setLong

public void setLong(int offset,
                    long value)

Description copied from interface: StructuredWritableBuffer

Sets a 64 bit Long value at the specified index.

Specified by:

setLong in interface StructuredWritableBuffer

Parameters:

offset - The index to set the value at.

value - The Long value to set.

getAllocatedLength

public int getAllocatedLength()

Description copied from interface: BufferView

Gets a value indicating the amount of memory (in bytes) allocated for this BufferView.

Specified by:

getAllocatedLength in interface BufferView

Returns:

The allocated memory size.

getBufferViewReader

public io.pravega.common.util.CompositeByteArraySegment.CompositeReader getBufferViewReader()

Description copied from interface: BufferView

Creates a new BufferView.Reader that can be used to read this BufferView. This reader is preferable to BufferView.getReader() that returns an InputStream as it contains optimized methods for copying directly into other BufferView instances, such as ByteArraySegments.

Specified by:

getBufferViewReader in interface BufferView

Returns:

A new BufferView.Reader.

getReader

public java.io.InputStream getReader()

Description copied from interface: BufferView

Creates an InputStream that can be used to read the contents of this BufferView. The InputStream returned spans the entire BufferView.

Specified by:

getReader in interface BufferView

Returns:

The InputStream.

getReader

public java.io.InputStream getReader(int offset,
                                     int length)

Description copied from interface: BufferView

Creates an InputStream that can be used to read the contents of this BufferView.

Specified by:

getReader in interface BufferView

Parameters:

offset - The starting offset of the section to read.

length - The length of the section to read.

Returns:

The InputStream.

slice

public CompositeArrayView slice(int offset,
                                int length)

Description copied from interface: CompositeArrayView

Creates a new CompositeArrayView that represents a sub-range of this CompositeArrayView instance. The new instance will share the same backing part(s) as this one, so a change to one will be reflected in the other.

Specified by:

slice in interface BufferView

Specified by:

slice in interface CompositeArrayView

Parameters:

offset - The starting offset to begin the slice at.

length - The sliced length.

Returns:

A new CompositeArrayView.

collect

public <ExceptionT extends java.lang.Exception> void collect(BufferView.Collector<ExceptionT> bufferCollector)
                                                      throws ExceptionT extends java.lang.Exception

Description copied from interface: BufferView

Iterates through each of the buffers that make up this BufferView, in order, and invokes the given BufferView.Collector on each.

Specified by:

collect in interface BufferView

Type Parameters:

ExceptionT - Type of exception that the BufferView.Collector function throws, if any.

Parameters:

bufferCollector - A BufferView.Collector function that will be invoked for each component. Each ByteBuffer passed as an argument to this function is a direct pointer to the data contained within the BufferView (i.e., they are not copies of the data).

Throws:

ExceptionT - If the BufferView.Collector function throws an exception of this type, the iteration will end and the exception will be bubbled up.

ExceptionT extends java.lang.Exception

iterateBuffers

public java.util.Iterator<java.nio.ByteBuffer> iterateBuffers()

Description copied from interface: BufferView

Gets an Iterator through each of the ByteBuffers that make up this BufferView, in order.

Specified by:

iterateBuffers in interface BufferView

Returns:

A Iterator.

getComponentCount

public int getComponentCount()

Description copied from interface: CompositeArrayView

Gets the number of components in this CompositeArrayView instance.

Specified by:

getComponentCount in interface CompositeArrayView

Returns:

The number of components. This is the exact number of argument invocations for BufferView.collect(Collector).

getCopy

public byte[] getCopy()

Description copied from interface: BufferView

Returns a copy of the contents of this BufferView.

Specified by:

getCopy in interface BufferView

Returns:

A byte array with the same length as this BufferView, containing a copy of the data within it.

copyFrom

public void copyFrom(BufferView.Reader source,
                     int targetOffset,
                     int length)

Description copied from interface: CompositeArrayView

Copies a specified number of bytes from the given BufferView.Reader into this CompositeArrayView.

Specified by:

copyFrom in interface CompositeArrayView

Parameters:

source - The BufferView.Reader to copy bytes from.

targetOffset - The offset within this CompositeArrayView to start copying at.

length - The number of bytes to copy.

copyTo

public void copyTo(java.io.OutputStream target)
            throws java.io.IOException

Description copied from interface: BufferView

Copies the contents of this BufferView to the given OutputStream.

Specified by:

copyTo in interface BufferView

Parameters:

target - The OutputStream to write to.

Throws:

java.io.IOException - If an exception occurred while writing to the target OutputStream.

copyTo

public int copyTo(java.nio.ByteBuffer target)

Description copied from interface: BufferView

Copies the contents of this BufferView to the given ByteBuffer.

Specified by:

copyTo in interface BufferView

Parameters:

target - The ByteBuffer to copy to. This buffer must have sufficient capacity to allow the entire contents of the BufferView to be written. If less needs to be copied, consider using BufferView.slice() to select a sub-range of this BufferView.

Returns:

The number of bytes copied.

getLength

public int getLength()

Description copied from interface: BufferView

Gets a value representing the length of this BufferView.

Specified by:

getLength in interface BufferView

Returns:

The length.