io.lacuna.bifurcan

Interface IDiffMap<K,V>

All Superinterfaces:

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

All Known Subinterfaces:

IDiffMap.Durable<K,V>

All Known Implementing Classes:

DiffMap

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	IDiffMap.Durable<K,V>

Nested classes/interfaces inherited from interface io.lacuna.bifurcan.IMap

IMap.Mixin<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 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)
IDiffMap<K,V>	rebase(IMap<K,V> newUnderlying) Returns a new diff, which is rebased atop the new underlying collection.
ISortedSet<Long>	removedIndices() Indices which have been removed or shadowed from the underlying data structure.
default IMap.Durable<K,V>	save(IDurableEncoding encoding, Path directory)
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, diff, difference, difference, entries, equals, forked, get, get, getOrCreate, hashSortedEntries, intersection, intersection, isLinear, iterator, keys, linear, mapValues, merge, put, put, remove, sliceIndices, split, spliterator, stream, toMap, union, update, values

Methods inherited from interface io.lacuna.bifurcan.ICollection

clone, nth

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>>

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.

rebase

IDiffMap<K,V> rebase(IMap<K,V> newUnderlying)

Description copied from interface: IDiff

Returns a new diff, which is rebased atop the new underlying collection. The returned diff may not reflect any changes which cannot be applied to the new collection (removing an element which isn't present in the new collection, for instance), and so a.rebase(b).rebase(c) is not necessarily equivalent to a.rebase(c) .

Specified by:

rebase in interface IDiff<IMap<K,V>>

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

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 ICollection<IMap<K,V>,IEntry<K,V>>

Specified by:

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

save

default IMap.Durable<K,V> save(IDurableEncoding encoding,
                               Path directory)

Specified by:

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

Specified by:

save in interface IMap<K,V>