Package org.apache.flink.state.forst.sync

Class TreeOrderedSetCache

java.lang.Object

org.apache.flink.state.forst.sync.TreeOrderedSetCache

All Implemented Interfaces:

ForStDBCachingPriorityQueueSet.OrderedByteArraySetCache

public class TreeOrderedSetCache
extends Object
implements ForStDBCachingPriorityQueueSet.OrderedByteArraySetCache

Implementation of a lexicographically ordered set of byte-arrays, based on a TreeSet.

Field Summary

Fields inherited from interface org.apache.flink.state.forst.sync.ForStDBCachingPriorityQueueSet.OrderedByteArraySetCache

LEXICOGRAPHIC_BYTE_COMPARATOR

Method Summary

Modifier and Type	Method	Description
boolean	add(byte[] toAdd)	Adds the given element, if it was not already contained.
void	bulkLoadFromOrderedIterator(Iterator<byte[]> orderedIterator)	Clears the cache and adds up to maxSize() elements from the iterator to the cache.
boolean	isEmpty()	Returns size() == 0.
boolean	isFull()	Returns size() == maxSize().
int	maxSize()	Returns the maximum number of elements that can be stored in the cache.
byte[]	peekFirst()	Returns the first element or null if empty.
byte[]	peekLast()	Returns the last element or null if empty.
byte[]	pollFirst()	Returns and removes the first element or returns null if empty.
byte[]	pollLast()	Returns and removes the last element or returns null if empty.
boolean	remove(byte[] toRemove)	Removes the given element, if it is contained.
int	size()	Returns the number of contained elements.

Methods inherited from class java.lang.Object

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

Method Detail

size

public int size()

Description copied from interface: ForStDBCachingPriorityQueueSet.OrderedByteArraySetCache

Returns the number of contained elements.

Specified by:

size in interface ForStDBCachingPriorityQueueSet.OrderedByteArraySetCache

maxSize

public int maxSize()

Description copied from interface: ForStDBCachingPriorityQueueSet.OrderedByteArraySetCache

Returns the maximum number of elements that can be stored in the cache.

Specified by:

maxSize in interface ForStDBCachingPriorityQueueSet.OrderedByteArraySetCache

isEmpty

public boolean isEmpty()

Description copied from interface: ForStDBCachingPriorityQueueSet.OrderedByteArraySetCache

Returns size() == 0.

Specified by:

isEmpty in interface ForStDBCachingPriorityQueueSet.OrderedByteArraySetCache

isFull

public boolean isFull()

Description copied from interface: ForStDBCachingPriorityQueueSet.OrderedByteArraySetCache

Returns size() == maxSize().

Specified by:

isFull in interface ForStDBCachingPriorityQueueSet.OrderedByteArraySetCache

add

public boolean add(@Nonnull
                   byte[] toAdd)

Description copied from interface: ForStDBCachingPriorityQueueSet.OrderedByteArraySetCache

Adds the given element, if it was not already contained. Returns true iff the cache was modified.

Specified by:

add in interface ForStDBCachingPriorityQueueSet.OrderedByteArraySetCache

remove

public boolean remove(@Nonnull
                      byte[] toRemove)

Description copied from interface: ForStDBCachingPriorityQueueSet.OrderedByteArraySetCache

Removes the given element, if it is contained. Returns true iff the cache was modified.

Specified by:

remove in interface ForStDBCachingPriorityQueueSet.OrderedByteArraySetCache

peekFirst

@Nullable
public byte[] peekFirst()

Description copied from interface: ForStDBCachingPriorityQueueSet.OrderedByteArraySetCache

Returns the first element or null if empty.

Specified by:

peekFirst in interface ForStDBCachingPriorityQueueSet.OrderedByteArraySetCache

peekLast

@Nullable
public byte[] peekLast()

Description copied from interface: ForStDBCachingPriorityQueueSet.OrderedByteArraySetCache

Returns the last element or null if empty.

Specified by:

peekLast in interface ForStDBCachingPriorityQueueSet.OrderedByteArraySetCache

pollFirst

@Nullable
public byte[] pollFirst()

Description copied from interface: ForStDBCachingPriorityQueueSet.OrderedByteArraySetCache

Returns and removes the first element or returns null if empty.

Specified by:

pollFirst in interface ForStDBCachingPriorityQueueSet.OrderedByteArraySetCache

pollLast

@Nullable
public byte[] pollLast()

Description copied from interface: ForStDBCachingPriorityQueueSet.OrderedByteArraySetCache

Returns and removes the last element or returns null if empty.

Specified by:

pollLast in interface ForStDBCachingPriorityQueueSet.OrderedByteArraySetCache

bulkLoadFromOrderedIterator

public void bulkLoadFromOrderedIterator(@Nonnull
                                        Iterator<byte[]> orderedIterator)

Description copied from interface: ForStDBCachingPriorityQueueSet.OrderedByteArraySetCache

Clears the cache and adds up to maxSize() elements from the iterator to the cache. Iterator must be ordered in the same order as this cache.

Specified by:

bulkLoadFromOrderedIterator in interface ForStDBCachingPriorityQueueSet.OrderedByteArraySetCache

Parameters:

orderedIterator - iterator with elements in-order.