Package io.permazen.kv.util

Class KVNavigableSet

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractSet<E>

io.permazen.util.AbstractIterationSet<E>

io.permazen.util.AbstractNavigableSet<E>

io.permazen.kv.util.AbstractKVNavigableSet<ByteData>

io.permazen.kv.util.KVNavigableSet

All Implemented Interfaces:

Iterable<ByteData>, Collection<ByteData>, NavigableSet<ByteData>, Set<ByteData>, SortedSet<ByteData>

public class KVNavigableSet
extends AbstractKVNavigableSet<ByteData>

A NavigableSet view of the keys in a KVStore.

Instances are mutable, with these exceptions:

• Adding new elements via add() is not supported
• clear() is not supported when a KeyFilter is configured

Field Summary

Fields inherited from class io.permazen.kv.util.AbstractKVNavigableSet

keyFilter, keyRange, kv, prefixMode, reversed

Fields inherited from class io.permazen.util.AbstractNavigableSet

bounds

Constructor Summary

Constructors

Modifier	Constructor	Description
	KVNavigableSet(KVStore kv)	Constructor for when there are no range restrictions.
protected	KVNavigableSet(KVStore kv, boolean reversed, KeyRange keyRange, KeyFilter keyFilter)	Primary constructor.
	KVNavigableSet(KVStore kv, ByteData prefix)	Constructor for when the range of visible KVStore keys is all keys sharing a given byte[] prefix.

Method Summary

Modifier and Type	Method	Description
void	clear()
Comparator<ByteData>	comparator()
protected NavigableSet<ByteData>	createSubSet(boolean newReversed, KeyRange newKeyRange, KeyFilter newKeyFilter, Bounds<ByteData> newBounds)	Create a (possibly reversed) view of this instance with (possibly) tighter lower and/or upper bounds and the given KeyFilter, if any.
protected ByteData	decode(ByteData.Reader reader)	Decode an element from a byte[] key.
protected void	encode(ByteData.Writer writer, Object obj)	Encode the given object into a byte[] key.
boolean	remove(Object obj)	Removes the given element from this set if it is present.

Methods inherited from class io.permazen.kv.util.AbstractKVNavigableSet

contains, createSubSet, encodeVisible, filterKeys, first, isEmpty, isVisible, isWithinLowerBound, isWithinUpperBound, iterator, last, pollFirst, pollLast

Methods inherited from class io.permazen.util.AbstractNavigableSet

buildSpliterator, ceiling, descendingIterator, descendingSet, floor, getBounds, getComparator, headSet, headSet, higher, lower, searchAbove, searchBelow, subSet, subSet, tailSet, tailSet

Methods inherited from class io.permazen.util.AbstractIterationSet

equals, hashCode, size, spliterator, stream, toArray, toArray

Methods inherited from class java.util.AbstractSet

removeAll

Methods inherited from class java.util.AbstractCollection

add, addAll, containsAll, retainAll, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.Set

add, addAll, containsAll, equals, hashCode, removeAll, retainAll, size, toArray, toArray

Methods inherited from interface java.util.SortedSet

spliterator

Constructor Details

KVNavigableSet

public KVNavigableSet(KVStore kv)

Constructor for when there are no range restrictions.

Parameters:

kv - underlying KVStore

KVNavigableSet

public KVNavigableSet(KVStore kv,
 ByteData prefix)

Constructor for when the range of visible KVStore keys is all keys sharing a given byte[] prefix.

Parameters:

kv - underlying KVStore

prefix - prefix defining minimum and maximum keys

Throws:

NullPointerException - if prefix is null

KVNavigableSet

protected KVNavigableSet(KVStore kv,
 boolean reversed,
 KeyRange keyRange,
 KeyFilter keyFilter)

Primary constructor.

Parameters:

kv - underlying KVStore

reversed - whether ordering is reversed

keyRange - key range restriction, or null for none

keyFilter - key filter, or null for none

Throws:

IllegalArgumentException - if kv is null

Method Details

comparator

public Comparator<ByteData> comparator()

remove

public boolean remove(Object obj)

Description copied from class: AbstractNavigableSet

Removes the given element from this set if it is present.

The implementation in AbstractNavigableSet always throws UnsupportedOperationException.

Specified by:

remove in interface Collection<ByteData>

Specified by:

remove in interface Set<ByteData>

Overrides:

remove in class AbstractNavigableSet<ByteData>

clear

public void clear()

Specified by:

clear in interface Collection<ByteData>

Specified by:

clear in interface Set<ByteData>

Overrides:

clear in class AbstractCollection<ByteData>

encode

protected void encode(ByteData.Writer writer,
 Object obj)

Description copied from class: AbstractKVNavigableSet

Encode the given object into a byte[] key. Note that this method must throw IllegalArgumentException, not ClassCastException or NullPointerException, if obj does not have the correct type or is an illegal null value.

Specified by:

encode in class AbstractKVNavigableSet<ByteData>

Parameters:

writer - output for encoded byte[] key corresponding to obj

obj - set element

decode

protected ByteData decode(ByteData.Reader reader)

Description copied from class: AbstractKVNavigableSet

Decode an element from a byte[] key.

If not in prefix mode, all of reader must be consumed; otherwise, the consumed portion is the prefix and any following keys with the same prefix are ignored.

Specified by:

decode in class AbstractKVNavigableSet<ByteData>

Parameters:

reader - input for encoded bytes

Returns:

decoded set element

createSubSet

protected NavigableSet<ByteData> createSubSet(boolean newReversed,
 KeyRange newKeyRange,
 KeyFilter newKeyFilter,
 Bounds<ByteData> newBounds)

Description copied from class: AbstractKVNavigableSet

Create a (possibly reversed) view of this instance with (possibly) tighter lower and/or upper bounds and the given KeyFilter, if any. The bounds are consistent with the reversed ordering (i.e., reversed if reverse is true) and have already been range-checked against this instance's bounds.

Specified by:

createSubSet in class AbstractKVNavigableSet<ByteData>

Parameters:

newReversed - whether the new set's ordering should be reversed (implies newBounds are also inverted, but not keyRange); note: means "absolutely" reversed, not relative to this instance

newKeyRange - new key range, or null for none; will be consistent with bounds, if any

newKeyFilter - new key filter, or null for none

newBounds - new bounds

Returns:

restricted and/or filtered view of this instance