com.worksap.icefig.lang

Interface Hash<K,V>

All Known Subinterfaces:

MutableHash<K,V>

public interface Hash<K,V>

Elegant supplement for Map in JDK

Method Summary

Modifier and Type	Method and Description
boolean	containsAny(java.util.function.BiPredicate<K,V> condition) Check whether this hash contains any key-value pair that satisfies the condition.
boolean	containsKey(K key) Returns true if this hash contains a mapping for the specified key.
boolean	containsValue(V value)
int	count(V value) Returns the number of the specified value in this hash.
int	countIf(java.util.function.BiPredicate<K,V> condition) Returns the number of entries which satisfy the condition.
Seq<java.util.Map.Entry<K,V>>	entrySeq() Returns a Seq view of the mappings contained in this hash.
Hash<K,V>	filter(java.util.function.BiPredicate<K,V> condition) Return a new hash with the key-value pairs of the original Hash which satisfy the condition.
V	get(K k)
Hash<V,K>	invert() Returns a new hash created by using hash’s values as keys, and the keys as values.
boolean	isEmpty()
Seq<K>	keys() Returns a Seq view of the keys contained in this hash.
Seq<K>	keysOf(V value) Returns a Seq of keys of the given value.
Hash<K,V>	merge(Hash<? extends K,? extends V> another) Returns a new hash containing the mappings of the specified hash and this hash itself.
Hash<K,V>	put(K k, V v)
Hash<K,V>	putIfAbsent(K k, V v)
Hash<K,V>	reject(java.util.function.BiPredicate<K,V> condition) Return a new hash with the key-value pairs of the original Hash which don't satisfy the condition.
Hash<K,V>	remove(K key) Removes the mapping for a key from this map if it is present (optional operation).
Hash<K,V>	remove(K key, V value) Removes the entry for the specified key only if it is currently mapped to the specified value.
Hash<K,V>	replace(K key, V value) Replaces the entry for the specified key only if it is currently mapped to some value.
Hash<K,V>	replace(K key, V oldValue, V newValue) Replaces the entry for the specified key only if currently mapped to the specified value.
Hash<K,V>	replaceAll(java.util.function.BiFunction<? super K,? super V,? extends V> function) Replaces each entry's value with the result of invoking the given function on that entry until all entries have been processed or the function throws an exception.
int	size()
Seq<V>	values() Returns a Seq view of the values contained in this hash.

Method Detail

containsAny

boolean containsAny(java.util.function.BiPredicate<K,V> condition)

Check whether this hash contains any key-value pair that satisfies the condition.

Parameters:

condition - the condition used to filter key-value pairs by passing the key and value of the pair, returns true if the key-value pair satisfies the condition, otherwise returns false.

Returns:

whether this hash contains any key-value pair that satisfies the condition

Throws:

java.lang.NullPointerException - if condition is null

containsKey

boolean containsKey(K key)

Returns true if this hash contains a mapping for the specified key. More formally, returns true if and only if this hash contains a mapping for a key k such that (key==null ? k==null : key.equals(k)). (There can be at most one such mapping.)

Parameters:

key - key whose presence in this hash is to be tested

Returns:

true if this hash contains a mapping for the specified key

Throws:

java.lang.ClassCastException - if the key is of an inappropriate type for this map

java.lang.NullPointerException - if the specified key is null and this map does not permit null keys

containsValue

boolean containsValue(V value)

isEmpty

boolean isEmpty()

size

int size()

get

V get(K k)

values

Seq<V> values()

Returns a Seq view of the values contained in this hash.

Returns:

a seq view of the values contained in this hash

keys

Seq<K> keys()

Returns a Seq view of the keys contained in this hash.

Returns:

a seq view of the keys contained in this hash

entrySeq

Seq<java.util.Map.Entry<K,V>> entrySeq()

Returns a Seq view of the mappings contained in this hash.

Returns:

a seq view of the mappings contained in this hash

put

Hash<K,V> put(K k,
              V v)

putIfAbsent

Hash<K,V> putIfAbsent(K k,
                      V v)

filter

Hash<K,V> filter(java.util.function.BiPredicate<K,V> condition)

Return a new hash with the key-value pairs of the original Hash which satisfy the condition.

Parameters:

condition - the condition used to filter key-value pairs by passing the key and value of the pair, returns true if the key-value pair satisfies the condition, otherwise returns false.

Returns:

a new with only key-value pairs which satisfy the condition

Throws:

java.lang.NullPointerException - if condition is null

reject

Hash<K,V> reject(java.util.function.BiPredicate<K,V> condition)

Return a new hash with the key-value pairs of the original Hash which don't satisfy the condition.

Parameters:

condition - the condition used to filter key-value pairs by passing the key and value of the pair, returns true if the key-value pair satisfies the condition, otherwise returns false.

Returns:

a new hash with key-value pairs which don't satisfy the condition

Throws:

java.lang.NullPointerException - if condition is null

invert

Hash<V,K> invert()

Returns a new hash created by using hash’s values as keys, and the keys as values. If there are duplicated values, the last key is kept. Since it is hash map, the order of keys is decided by hash table.

Returns:

an inverted hash

merge

Hash<K,V> merge(Hash<? extends K,? extends V> another)

Returns a new hash containing the mappings of the specified hash and this hash itself. The value for entries with duplicate keys will be that of the specified hash.

Parameters:

another - the specified hash to be merged

Returns:

the new hash containing all the mappings of the specified hash and this hash itself

remove

Hash<K,V> remove(K key)

Removes the mapping for a key from this map if it is present (optional operation). More formally, if this hash contains a mapping from key k to value v such that (key==null ? k==null : key.equals(k)), that mapping is removed. (The map can contain at most one such mapping.)

Parameters:

key - key whose mapping is to be removed from the map

Returns:

a new hash after the key is removed

Throws:

java.lang.UnsupportedOperationException - if the remove operation is not supported by this hash

java.lang.ClassCastException - if the key is of an inappropriate type for this hash

java.lang.NullPointerException - if the specified key is null and this hash does not permit null keys

remove

Hash<K,V> remove(K key,
                 V value)

Removes the entry for the specified key only if it is currently mapped to the specified value.

Parameters:

key - key with which the specified value is associated

value - value expected to be associated with the specified key

Returns:

a new hash after the entry is removed

Throws:

java.lang.UnsupportedOperationException - if the remove operation is not supported by this hash

java.lang.ClassCastException - if the key or value is of an inappropriate type for this hash

java.lang.NullPointerException - if the specified key or value is null, and this map does not permit null keys or values

keysOf

Seq<K> keysOf(V value)

Returns a Seq of keys of the given value.

Parameters:

value - the value

Returns:

the collection of keys whose value is the given value

replace

Hash<K,V> replace(K key,
                  V value)

Replaces the entry for the specified key only if it is currently mapped to some value.

Parameters:

key - key with which the specified value is associated

value - value to be associated with the specified key

Returns:

a new hash after the entry is replaced

Throws:

java.lang.ClassCastException - if the class of the specified key or value prevents it from being stored in this hash

java.lang.NullPointerException - if the specified key or value is null, and this hash does not permit null keys or values

java.lang.IllegalArgumentException - if some property of the specified key or value prevents it from being stored in this hash

replace

Hash<K,V> replace(K key,
                  V oldValue,
                  V newValue)

Replaces the entry for the specified key only if currently mapped to the specified value.

Parameters:

key - key with which the specified value is associated

oldValue - value expected to be associated with the specified key

newValue - value to be associated with the specified key

Returns:

a new hash after the entry is replaced

Throws:

java.lang.UnsupportedOperationException - if the put operation is not supported by this hash

java.lang.ClassCastException - if the class of a specified key or value prevents it from being stored in this hash

java.lang.NullPointerException - if a specified key or newValue is null, and this hash does not permit null keys or values

java.lang.NullPointerException - if oldValue is null and this hash does not permit null values

java.lang.IllegalArgumentException - if some property of a specified key or value prevents it from being stored in this hash

replaceAll

Hash<K,V> replaceAll(java.util.function.BiFunction<? super K,? super V,? extends V> function)

Replaces each entry's value with the result of invoking the given function on that entry until all entries have been processed or the function throws an exception. Exceptions thrown by the function are relayed to the caller.

Parameters:

function - the function to apply to each entry

Returns:

a new hash after all the entries are replaced

Throws:

java.lang.UnsupportedOperationException - if the set operation is not supported by this hash's entry set iterator.

java.lang.ClassCastException - if the class of a replacement value prevents it from being stored in this hash

java.lang.NullPointerException - if the specified function is null, or the specified replacement value is null, and this hash does not permit null values

java.lang.ClassCastException - if a replacement value is of an inappropriate type for this hash

java.lang.NullPointerException - if function or a replacement value is null, and this hash does not permit null keys or values

java.lang.IllegalArgumentException - if some property of a replacement value prevents it from being stored in this hash

java.util.ConcurrentModificationException - if an entry is found to be removed during iteration

count

int count(V value)

Returns the number of the specified value in this hash.

Parameters:

value - the value to count

Returns:

the number of the specified value in this hash

countIf

int countIf(java.util.function.BiPredicate<K,V> condition)

Returns the number of entries which satisfy the condition.

Parameters:

condition - the condition used to filter entries by passing the key and the value, returns true if the entry satisfies the condition, otherwise returns false.

Returns:

the number of entries which satisfy the condition

Throws:

java.lang.NullPointerException - if condition is null