io.lacuna.bifurcan

Interface IDiffMap<K,V>

All Superinterfaces:

Function<K,V>, ICollection<IMap<K,V>,IEntry<K,V>>, IDiff<IMap<K,V>,IEntry<K,V>>, IMap<K,V>, Iterable<IEntry<K,V>>

All Known Implementing Classes:

DiffMap

public interface IDiffMap<K,V>
extends IMap<K,V>, IDiff<IMap<K,V>,IEntry<K,V>>

Method Summary

Modifier and Type	Method and Description
IMap<K,V>	added() Entries which have been added to the underlying data structure, some of which may shadow underlying entries.
default V	get(K key, V defaultValue)
default OptionalLong	indexOf(K key)
default Iterator<IEntry<K,V>>	iterator()
default BiPredicate<K,K>	keyEquality()
default ToLongFunction<K>	keyHash()
default IEntry<K,V>	nth(long idx)
ISortedSet<Long>	removedIndices() Indices which have been removed or shadowed from the underlying data structure.
default long	size()
IMap<K,V>	underlying() The baseline data structure.

Methods inherited from interface io.lacuna.bifurcan.IMap

apply, contains, containsAll, containsAll, containsAny, containsAny, difference, difference, entries, equals, forked, get, getOrCreate, hashSortedEntries, intersection, intersection, isLinear, keys, linear, mapValues, merge, put, put, remove, save, split, spliterator, stream, toMap, union, update, values

Methods inherited from interface io.lacuna.bifurcan.ICollection

clone, nth, save

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.function.Function

andThen, compose, identity

Method Detail

underlying

IMap<K,V> underlying()

The baseline data structure.

Specified by:

underlying in interface IDiff<IMap<K,V>,IEntry<K,V>>

added

IMap<K,V> added()

Entries which have been added to the underlying data structure, some of which may shadow underlying entries.

removedIndices

ISortedSet<Long> removedIndices()

Indices which have been removed or shadowed from the underlying data structure.

keyHash

default ToLongFunction<K> keyHash()

Specified by:

keyHash in interface IMap<K,V>

Returns:

the hash function used by the map

keyEquality

default BiPredicate<K,K> keyEquality()

Specified by:

keyEquality in interface IMap<K,V>

Returns:

the key equality semantics used by the map

get

default V get(K key,
              V defaultValue)

Specified by:

get in interface IMap<K,V>

Returns:

the value under key, or defaultValue if there is no such key

indexOf

default OptionalLong indexOf(K key)

Specified by:

indexOf in interface IMap<K,V>

Returns:

the index of key within the collection, if it's present

size

default long size()

Specified by:

size in interface ICollection<IMap<K,V>,IEntry<K,V>>

Returns:

the number of elements in the collection

nth

default IEntry<K,V> nth(long idx)

Specified by:

nth in interface ICollection<IMap<K,V>,IEntry<K,V>>

Returns:

the element at idx

iterator

default Iterator<IEntry<K,V>> iterator()

Specified by:

iterator in interface IMap<K,V>

Specified by:

iterator in interface Iterable<IEntry<K,V>>

Returns:

an iterator over all entries in the map