io.zeebe.util.collection

Class CompactList

java.lang.Object

io.zeebe.util.collection.CompactList

All Implemented Interfaces:

CloseableSilently, AutoCloseable, Iterable<org.agrona.MutableDirectBuffer>

public class CompactList
extends Object
implements Iterable<org.agrona.MutableDirectBuffer>, CloseableSilently

Compact, off-heap list datastructure

Field Summary

Fields

Modifier and Type	Field and Description
protected AllocatedBuffer	allocatedBuffer
protected org.agrona.concurrent.UnsafeBuffer	elementBuffer
protected int	framedElementLength
protected CompactListIterator	iterator
protected org.agrona.concurrent.UnsafeBuffer	listBuffer

Constructor Summary

Constructors

Constructor and Description
CompactList(AllocatedBuffer allocatedBuffer, int elementMaxLength, int capacity)
CompactList(int elementMaxLength, int capacity, BufferAllocator bufferAllocator)
CompactList(org.agrona.concurrent.UnsafeBuffer listBuffer)

Method Summary

Modifier and Type	Method and Description
void	add(org.agrona.DirectBuffer srcBuffer) Appends the passed element to the end of the list.
void	add(org.agrona.DirectBuffer srcBuffer, int offset, int length) Appends the passed element to the end of the list.
void	add(org.agrona.DirectBuffer srcBuffer, int offset, int length, int idx) Adds the passed element at the given index.
protected void	boundsCheck(int index, int size)
protected void	boundsCheckIncludingSize(int index, int size)
int	capacity() Returns this list's capacity.
void	clear() Removes all of the elements from this list.
void	close()
int	copyInto(org.agrona.MutableDirectBuffer dstBuffer, int offset) Copy the underlying buffer into a supplied MutableDirectBuffer.
protected void	elementLengthCheck(int length)
int	find(org.agrona.DirectBuffer key, Comparator<org.agrona.DirectBuffer> c) Searches the list for the specified key using the binary search algorithm.
int	get(int idx, org.agrona.MutableDirectBuffer dstBuffer, int offset) Get the element from the list into a supplied MutableDirectBuffer.
int	getEncodedSize()
org.agrona.DirectBuffer	getRawBuffer()
protected IndexOutOfBoundsException	indexOutOfBoundsException(int index, int size)
CompactListIterator	iterator()
int	maxElementDataLength() Returns the maximal element data length.
void	remove(int idx) Removes the element at the specified position in this list.
void	set(int idx, org.agrona.DirectBuffer srcBuffer) Replaces the element at the specified position in this list with the specified element.
void	set(int idx, org.agrona.DirectBuffer srcBuffer, int offset, int length) Replaces the element at the specified position in this list with the specified element.
protected void	setMemory(int idx, int length, byte value)
protected void	setSize(int size)
protected void	setValue(org.agrona.DirectBuffer buffer, int offset, int length, int idx)
protected void	setValue(org.agrona.DirectBuffer buffer, int offset, int length, int idx, int elementOffset)
int	size() Returns the number of contained elements by the list.
int	sizeVolatile()
InputStream	toInputStream()
int	wrap(int idx, org.agrona.MutableDirectBuffer dstBuffer) Attach a view of the element to a MutableDirectBuffer for providing direct access.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

allocatedBuffer

protected final AllocatedBuffer allocatedBuffer

listBuffer

protected final org.agrona.concurrent.UnsafeBuffer listBuffer

elementBuffer

protected final org.agrona.concurrent.UnsafeBuffer elementBuffer

framedElementLength

protected final int framedElementLength

iterator

protected final CompactListIterator iterator

Constructor Detail

CompactList

public CompactList(int elementMaxLength,
                   int capacity,
                   BufferAllocator bufferAllocator)

CompactList

public CompactList(AllocatedBuffer allocatedBuffer,
                   int elementMaxLength,
                   int capacity)

CompactList

public CompactList(org.agrona.concurrent.UnsafeBuffer listBuffer)

Method Detail

add

public void add(org.agrona.DirectBuffer srcBuffer)

Appends the passed element to the end of the list.

Parameters:

srcBuffer - from which the element bytes will be copied.

add

public void add(org.agrona.DirectBuffer srcBuffer,
                int offset,
                int length)

Appends the passed element to the end of the list.

Parameters:

srcBuffer - from which the element bytes will be copied.

offset - at which the element begins.

length - of the element.

add

public void add(org.agrona.DirectBuffer srcBuffer,
                int offset,
                int length,
                int idx)

Adds the passed element at the given index. Shifts the element currently at that position (if any) and any subsequent elements to the right

Parameters:

srcBuffer - from which the element bytes will be copied.

offset - at which the element begins.

length - of the element.

idx - at which the specified element is to be inserted.

set

public void set(int idx,
                org.agrona.DirectBuffer srcBuffer)

Replaces the element at the specified position in this list with the specified element.

Parameters:

idx - of the element to replace

srcBuffer - from which the element bytes will be copied.

set

public void set(int idx,
                org.agrona.DirectBuffer srcBuffer,
                int offset,
                int length)

Replaces the element at the specified position in this list with the specified element.

Parameters:

idx - of the element to replace

srcBuffer - from which the element bytes will be copied.

offset - at which the element begins.

length - of the element.

remove

public void remove(int idx)

Removes the element at the specified position in this list. Shifts any subsequent elements to the left (subtracts one from their indices).

Parameters:

idx - of the element to be removed.

size

public int size()

Returns the number of contained elements by the list.

Returns:

the number of contained elements.

sizeVolatile

public int sizeVolatile()

capacity

public int capacity()

Returns this list's capacity.

Returns:

the capacity of the list.

maxElementDataLength

public int maxElementDataLength()

Returns the maximal element data length.

Returns:

the maximal element data length.

get

public int get(int idx,
               org.agrona.MutableDirectBuffer dstBuffer,
               int offset)

Get the element from the list into a supplied MutableDirectBuffer.

Parameters:

idx - the element to supply.

dstBuffer - into which the element will be copied.

offset - of the supplied buffer to use.

Returns:

the length of the supplied element.

wrap

public int wrap(int idx,
                org.agrona.MutableDirectBuffer dstBuffer)

Attach a view of the element to a MutableDirectBuffer for providing direct access.

Parameters:

idx - the element to attach.

dstBuffer - to which the view of the element is attached.

Returns:

the length of the attached element.

getEncodedSize

public int getEncodedSize()

getRawBuffer

public org.agrona.DirectBuffer getRawBuffer()

find

public int find(org.agrona.DirectBuffer key,
                Comparator<org.agrona.DirectBuffer> c)

Searches the list for the specified key using the binary search algorithm. The list must be sorted into ascending order. If it is not sorted, the results are undefined. If the list contains multiple elements equal to the specified object, there is no guarantee which one will be found.

Parameters:

key - to be searched for.

c - used for comparison.

Returns:

the index of the search key, if it is contained in the list; otherwise, (-(insertion point) - 1). The insertion point is defined as the point at which the key would be inserted into the list: the index of the first element greater than the key, or size() if all elements in the list are less than the specified key. Note that this guarantees that the return value will be >= 0 if and only if the key is found.

copyInto

public int copyInto(org.agrona.MutableDirectBuffer dstBuffer,
                    int offset)

Copy the underlying buffer into a supplied MutableDirectBuffer.

Parameters:

dstBuffer - into which the underlying buffer is copied.

offset - of the supplied buffer to use.

Returns:

the length of the supplied copy of the underlying buffer.

clear

public void clear()

Removes all of the elements from this list. The list will be empty after this call returns.

boundsCheck

protected void boundsCheck(int index,
                           int size)

boundsCheckIncludingSize

protected void boundsCheckIncludingSize(int index,
                                        int size)

indexOutOfBoundsException

protected IndexOutOfBoundsException indexOutOfBoundsException(int index,
                                                              int size)

elementLengthCheck

protected void elementLengthCheck(int length)

setSize

protected void setSize(int size)

setValue

protected void setValue(org.agrona.DirectBuffer buffer,
                        int offset,
                        int length,
                        int idx)

setValue

protected void setValue(org.agrona.DirectBuffer buffer,
                        int offset,
                        int length,
                        int idx,
                        int elementOffset)

setMemory

protected void setMemory(int idx,
                         int length,
                         byte value)

iterator

public CompactListIterator iterator()

Specified by:

iterator in interface Iterable<org.agrona.MutableDirectBuffer>

toInputStream

public InputStream toInputStream()

close

public void close()

Specified by:

close in interface CloseableSilently

Specified by:

close in interface AutoCloseable