tech.codingzen.kata.hamt

Class KataMap<K,V>

tech.codingzen.kata.hamt.KataMap<K,V>

Type Parameters:

K -

key type

V -

value type

public class KataMap<K,V>

Persistent/Immutable implementation of a HashMap. This is a port of https://github.com/clojure/clojure/blob/master/src/jvm/clojure/lang/PersistentHashMap.java Create

val empty = KataMap()
val map = KataMap("a" to 1, "b" to 2)

Put

KataMap() + ("a" to 1")
KataMap().put("a", 1)

Del

val map = KataMap("a" to 1, "b" to 2)
val onlyB = map - "a"
val empty = map.del("a") - "b"

Get

val map = KataMap("a" to 1, "b" to 2)
val aValue = map["a"]
val none = map["c"] // null
val (a,b,c) = map["a", "b", "c"] // destructuring up to arity 8 (inclusive)

Size

val map = KataMap("a" to 1, "b" to 2)
map.size
map.isEmpty()
map.isNotEmpty()

Query

val map = KataMap("a" to 1, "b" to 2)
map.containsKey("a")
map.containsValue(2)
"a" in map
"c" !in map

Iteration

val map = KataMap("a" to 1, "b" to 2)
for ((k, v) in map) {
  //...
}
map.iterator()
map.asSequence() // Sequence>
map.entries // Set>
map.keys // Set
map.values // Collection

See Also:

https://github.com/clojure/clojure/blob/master/src/jvm/clojure/lang/PersistentHashMap.java

Field Detail

Companion

public static tech.codingzen.kata.hamt.KataMap.Companion Companion

Method Detail

put

@NotNull
public KataMap<K,V> put(K k,
                                  V v)

Parameters:

k - key

v - value

Returns:

a new class KataMap containing all the key-value pairs of this KataMap and key-value pair k, v Note that k,v will overwrite corresponding key-value pairs in this KataMap

put

@NotNull
public KataMap<K,V> put(@NotNull
                                  kotlin.Pair<? extends K,? extends V> kv,
                                  @NotNull
                                  kotlin.Pair... kvs)

Parameters:

kv - key-value pair to add

kvs - key-value pairs to add

Returns:

a new class KataMap containing all key-value pairs of this KataMap and key-value pairs kv and kvs

put

@NotNull
public KataMap<K,V> put(@NotNull
                                  java.util.Map.Entry<? extends K,? extends V> kv,
                                  @NotNull
                                  java.util.Map.Entry... kvs)

Parameters:

kv - key-value pair to add

kvs - key-value pairs to add

Returns:

a new class KataMap containing all key-value pairs of this KataMap and key-value pairs kv and kvs

plus

@NotNull
public KataMap<K,V> plus(@NotNull
                                   kotlin.Pair<? extends K,? extends V> kv)

Parameters:

kv - key-value pair to add

Returns:

a new class KataMap containing all key-value pairs of this KataMap and kv Note that kv will overwrite corresponding key-value pairs in this KataMap

plus

@NotNull
public KataMap<K,V> plus(@NotNull
                                   java.util.Map.Entry<? extends K,? extends V> kv)

Parameters:

kv - key-value pair to add

Returns:

a new class KataMap containing all key-value pairs of this KataMap and kv Note that kv will overwrite corresponding key-value pairs in this KataMap

plus

@NotNull
public KataMap<K,V> plus(@NotNull
                                   java.util.Map<K,? extends V> other)

Parameters:

other - map to merge with this KataMap

Returns:

a new class KataMap containing all the key-value pairs of this KataMap and all key-values pairs of other. Note that key-value pairs in other will overwrite corresponding key-value pairs in this KataMap

merge

@NotNull
public KataMap<K,V> merge(@NotNull
                                    java.util.Map<K,? extends V> other)

Parameters:

other - map to merge with this KataMap

Returns:

a new class KataMap containing all the key-value pairs of this KataMap and all key-values pairs of other. Note that key-value pairs in other will overwrite corresponding key-value pairs in this KataMap

plus

@NotNull
public KataMap<K,V> plus(@NotNull
                                   java.util.Collection<? extends kotlin.Pair<? extends K,? extends V>> kvs)

Parameters:

kvs - Collection of key-value pairs to merge with this Katamap

Returns:

a new class KataMap containing all the key-value pairs of this KataMap and all key-values pairs of kvs. Note that key-value pairs in kvs will overwrite corresponding key-value pairs in this KataMap

del

@NotNull
public KataMap<K,V> del(K k)

Parameters:

k - key to remove

Returns:

a new class KataMap containing all key-value pairs except for k

del

@NotNull
public KataMap<K,V> del(K k,
                                  @NotNull
                                  K... ks)

Parameters:

k - key to remove

ks - keys to remove

Returns:

a new class KataMap containing all key-value pairs except for k and ks

minus

@NotNull
public KataMap<K,V> minus(K k)

Parameters:

k - key to remove

Returns:

a new class KataMap containing all key-value pairs except for k

minus

@NotNull
public KataMap<K,V> minus(@NotNull
                                    java.util.Collection<? extends K> keys)

Parameters:

keys - keys to remove

Returns:

a new class KataMap containing all key-value pairs except for keys

get

@Nullable
public V get(java.lang.Object k)

Parameters:

k - key to lookup

Returns:

value or null associated with key k

get

@NotNull
public kotlin.Pair<V,V> get(K k0,
                                      K k1)

Parameters:

k0 - key to lookup

k1 - key to lookup

Returns:

value or null associated with each key k0, k1

get

@NotNull
public kotlin.Triple<V,V,V> get(K k0,
                                          K k1,
                                          K k2)

Parameters:

k0 - key to lookup

k1 - key to lookup

k2 - key to lookup

Returns:

value or null associated with each key k0, k1, k2

get

@NotNull
public KTuple4<V,V,V,V> get(K k0,
                                      K k1,
                                      K k2,
                                      K k3)

Parameters:

k0 - key to lookup

k1 - key to lookup

k2 - key to lookup

k3 - key to lookup

Returns:

value or null associated with each key k0, k1, k2, k3

get

@NotNull
public KTuple5<V,V,V,V,V> get(K k0,
                                        K k1,
                                        K k2,
                                        K k3,
                                        K k4)

Parameters:

k0 - key to lookup

k1 - key to lookup

k2 - key to lookup

k3 - key to lookup

k4 - key to lookup

Returns:

value or null associated with each key k0, k1, k2, k3, k4

get

@NotNull
public KTuple6<V,V,V,V,V,V> get(K k0,
                                          K k1,
                                          K k2,
                                          K k3,
                                          K k4,
                                          K k5)

Parameters:

k0 - key to lookup

k1 - key to lookup

k2 - key to lookup

k3 - key to lookup

k4 - key to lookup

k5 - key to lookup

Returns:

value or null associated with each key k0, k1, k2, k3, k4, k5

get

@NotNull
public KTuple7<V,V,V,V,V,V,V> get(K k0,
                                            K k1,
                                            K k2,
                                            K k3,
                                            K k4,
                                            K k5,
                                            K k6)

Parameters:

k0 - key to lookup

k1 - key to lookup

k2 - key to lookup

k3 - key to lookup

k4 - key to lookup

k5 - key to lookup

k6 - key to lookup

Returns:

value or null associated with each key k0, k1, k2, k3, k4, k5, k6

get

@NotNull
public KTuple8<V,V,V,V,V,V,V,V> get(K k0,
                                              K k1,
                                              K k2,
                                              K k3,
                                              K k4,
                                              K k5,
                                              K k6,
                                              K k7)

Parameters:

k0 - key to lookup

k1 - key to lookup

k2 - key to lookup

k3 - key to lookup

k4 - key to lookup

k5 - key to lookup

k6 - key to lookup

k7 - key to lookup

Returns:

value or null associated with each key k0, k1, k2, k3, k4, k5, k6, k7

contains

public boolean contains(K key)

Parameters:

key - key to lookup

Returns:

true if this KataMap contains key, false otherwise

containsKey

public boolean containsKey(java.lang.Object key)

Parameters:

key - key to lookup

Returns:

true if this KataMap contains key, false otherwise

containsValue

public boolean containsValue(java.lang.Object value)

Parameters:

value - value to lookup

Returns:

true if this KataMap contains value, false otherwise

isEmpty

public boolean isEmpty()

Returns:

true if this map is empty, false otherwise

getEntries

@NotNull
public java.util.Set<java.util.Map.Entry> getEntries()

A Set (backed by this KataMap) containing all key-value pairs in this KataMap

See Also:

Set

getKeys

@NotNull
public java.util.Set<K> getKeys()

A Set (backed by this KataMap) containing all keys in this KataMap

See Also:

Set

getValues

@NotNull
public java.util.Collection<V> getValues()

A Collection containing all values in this KataMap

See Also:

Collection

equals

public boolean equals(@Nullable
                      java.lang.Object other)

hashCode

public int hashCode()

toString

@NotNull
public java.lang.String toString()

getSize

public int getSize()