io.lacuna.bifurcan.diffs

Class DiffMap<K,V>

java.lang.Object

io.lacuna.bifurcan.IMap.Mixin<K,V>

io.lacuna.bifurcan.diffs.DiffMap<K,V>

All Implemented Interfaces:

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

public class DiffMap<K,V>
extends IMap.Mixin<K,V>
implements IDiffMap<K,V>

Nested Class Summary

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

IDiffMap.Durable<K,V>

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

IMap.Mixin<K,V>

Field Summary

Fields inherited from class io.lacuna.bifurcan.IMap.Mixin

hash

Constructor Summary

Constructors

Constructor and Description
DiffMap(IMap<K,V> underlying)

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.
DiffMap<K,V>	clone()
DiffMap<K,V>	forked() This returns a data structure which is forked, which is equivalent to Clojure's persistent data structures, also sometimes called functional or immutable.
boolean	isLinear()
DiffMap<K,V>	linear() This returns a data structure which is linear, or temporarily mutable.
DiffMap<K,V>	put(K key, V value, BinaryOperator<V> merge)
IDiffMap<K,V>	rebase(IMap<K,V> newUnderlying) Returns a new diff, which is rebased atop the new underlying collection.
DiffMap<K,V>	remove(K key)
ISortedSet<Long>	removedIndices() Indices which have been removed or shadowed from the underlying data structure.
IMap<K,V>	underlying() The baseline data structure.

Methods inherited from class io.lacuna.bifurcan.IMap.Mixin

equals, hashCode, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.lacuna.bifurcan.IDiffMap

indexOf, iterator, keyEquality, keyHash, nth, save, size

Methods inherited from interface io.lacuna.bifurcan.IMap

apply, contains, containsAll, containsAll, containsAny, containsAny, diff, difference, difference, entries, equals, get, get, getOrCreate, hashSortedEntries, intersection, intersection, iterator, keys, mapValues, merge, put, sliceIndices, split, spliterator, stream, toMap, union, update, values

Methods inherited from interface io.lacuna.bifurcan.ICollection

nth

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.function.Function

andThen, compose, identity

Constructor Detail

DiffMap

public DiffMap(IMap<K,V> underlying)

Method Detail

rebase

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

Specified by:

rebase in interface IDiffMap<K,V>

put

public DiffMap<K,V> put(K key,
                        V value,
                        BinaryOperator<V> merge)

Specified by:

put in interface IMap<K,V>

merge - a function which will be invoked if there is a pre-existing value under key, with the current value as the first argument and new value as the second, to determine the combined result

Returns:

an updated map with value under key

remove

public DiffMap<K,V> remove(K key)

Specified by:

remove in interface IMap<K,V>

Returns:

an updated map that does not contain key

isLinear

public boolean isLinear()

Specified by:

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

Specified by:

isLinear in interface IMap<K,V>

Returns:

true, if the collection is linear

forked

public DiffMap<K,V> forked()

Description copied from interface: ICollection

This returns a data structure which is forked, which is equivalent to Clojure's persistent data structures, also sometimes called functional or immutable. This is called "forked" because it means that multiple functions can make divergent changes to the data structure without affecting each other.

If only a single function or scope uses the data structure, it can be left as a linear data structure, which can have significant performance benefits.

If the data structure is already forked, it will simply return itself.

Specified by:

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

Specified by:

forked in interface IMap<K,V>

Returns:

a forked form of the data structure

linear

public DiffMap<K,V> linear()

Description copied from interface: ICollection

This returns a data structure which is linear, or temporarily mutable. The term "linear", as used here, does not completely align with the formal definition of linear types as used in type theory. It is meant to describe the linear dataflow of the method calls, and as a converse to "forked" data structures.

If ICollection.forked() is called on a linear collection, all references to that linear collection should be discarded.

If the data structure is already linear, it will simply return itself.

Specified by:

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

Specified by:

linear in interface IMap<K,V>

Returns:

a linear form of this data structure

underlying

public IMap<K,V> underlying()

Description copied from interface: IDiffMap

The baseline data structure.

Specified by:

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

Specified by:

underlying in interface IDiffMap<K,V>

added

public IMap<K,V> added()

Description copied from interface: IDiffMap

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

Specified by:

added in interface IDiffMap<K,V>

removedIndices

public ISortedSet<Long> removedIndices()

Description copied from interface: IDiffMap

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

Specified by:

removedIndices in interface IDiffMap<K,V>

clone

public DiffMap<K,V> clone()

Specified by:

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

Overrides:

clone in class IMap.Mixin<K,V>

Returns:

a cloned copy of the collection