MutableHash (icefig 0.2.4 API)

All Superinterfaces:

Hash<K,V>
```
public interface MutableHash<K,V>
extends Hash<K,V>
```
An interface extending Hash (which is immutable), with additional in-place methods to change the hash itself. Those methods are generally named xxxInPlace

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`MutableHash<K,V>`	`clear()` Remove all the key-value pair at this hash.
`MutableHash<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.
`MutableHash<K,V>`	`filterInPlace(java.util.function.BiPredicate<K,V> condition)` In-place method of `filter(BiPredicate)`
`MutableHash<V,K>`	`invert()` Returns a new hash created by using hash’s values as keys, and the keys as values.
`Seq<K>`	`keysOf(V v)` Returns a Seq of keys of the given value.
`MutableHash<K,V>`	`merge(Hash<? extends K,? extends V> another)` Returns a new hash containing the mappings of the specified hash and this hash itself.
`MutableHash<K,V>`	`mergeInPlace(Hash<? extends K,? extends V> another)` In-place method of `merge(Hash)`
`MutableHash<K,V>`	`put(K k, V v)`
`MutableHash<K,V>`	`putIfAbsent(K k, V v)`
`MutableHash<K,V>`	`putIfAbsentInPlace(K k, V v)` In-place method of `#putIfAbsent(K, V)`
`MutableHash<K,V>`	`putInPlace(K k, V v)` In-place method of `#put(K, V)`
`MutableHash<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.
`MutableHash<K,V>`	`rejectInPlace(java.util.function.BiPredicate<K,V> condition)` In-place method of `reject(BiPredicate)`
`MutableHash<K,V>`	`remove(K k)` Removes the mapping for a key from this map if it is present (optional operation).
`MutableHash<K,V>`	`remove(K k, V v)` Removes the entry for the specified key only if it is currently mapped to the specified value.
`MutableHash<K,V>`	`removeInPlace(K k)` In-place method of `#remove(K)`
`MutableHash<K,V>`	`removeInPlace(K k, V v)` In-place method of `#remove(K, V)`
`MutableHash<K,V>`	`replace(K k, V v)` Replaces the entry for the specified key only if it is currently mapped to some value.
`MutableHash<K,V>`	`replace(K k, V oldValue, V newValue)` Replaces the entry for the specified key only if currently mapped to the specified value.
`MutableHash<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.
`MutableHash<K,V>`	`replaceAllInPlace(java.util.function.BiFunction<? super K,? super V,? extends V> function)` In-place method of `replaceAll(BiFunction)`
`MutableHash<K,V>`	`replaceInPlace(K k, V v)` In-place method of `#replace(K, V)`
`MutableHash<K,V>`	`replaceInPlace(K k, V oldValue, V newValue)` In-place method of `#replace(K, V, V)`

Methods inherited from interface com.worksap.fig.lang.Hash
containsAny, containsKey, containsValue, count, countIf, entrySeq, get, isEmpty, keys, size, values

- Method Detail
  - put
```
MutableHash<K,V> put(K k,
                     V v)
```
    Specified by:
    
    put in interface Hash<K,V>
  - putIfAbsent
```
MutableHash<K,V> putIfAbsent(K k,
                             V v)
```
    Specified by:
    
    putIfAbsent in interface Hash<K,V>
  - filter
```
MutableHash<K,V> filter(java.util.function.BiPredicate<K,V> condition)
```
    Description copied from interface: Hash
    
    Return a new hash with the key-value pairs of the original Hash which satisfy the condition.
    
    Specified by:
    
    filter in interface Hash<K,V>
    
    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
  - reject
```
MutableHash<K,V> reject(java.util.function.BiPredicate<K,V> condition)
```
    Description copied from interface: Hash
    
    Return a new hash with the key-value pairs of the original Hash which don't satisfy the condition.
    
    Specified by:
    
    reject in interface Hash<K,V>
    
    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
  - invert
```
MutableHash<V,K> invert()
```
    Description copied from interface: Hash
    
    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.
    
    Specified by:
    
    invert in interface Hash<K,V>
    
    Returns:
    
    an inverted hash
  - merge
```
MutableHash<K,V> merge(Hash<? extends K,? extends V> another)
```
    Description copied from interface: Hash
    
    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.
    
    Specified by:
    
    merge in interface Hash<K,V>
    
    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
```
MutableHash<K,V> remove(K k)
```
    Description copied from interface: Hash
    
    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.)
    
    Specified by:
    
    remove in interface Hash<K,V>
    
    Parameters:
    
    k - key whose mapping is to be removed from the map
    
    Returns:
    
    a new hash after the key is removed
  - remove
```
MutableHash<K,V> remove(K k,
                        V v)
```
    Description copied from interface: Hash
    
    Removes the entry for the specified key only if it is currently mapped to the specified value.
    
    Specified by:
    
    remove in interface Hash<K,V>
    
    Parameters:
    
    k - key with which the specified value is associated
    
    v - value expected to be associated with the specified key
    
    Returns:
    
    a new hash after the entry is removed
  - keysOf
```
Seq<K> keysOf(V v)
```
    Description copied from interface: Hash
    
    Returns a Seq of keys of the given value.
    
    Specified by:
    
    keysOf in interface Hash<K,V>
    
    Parameters:
    
    v - the value
    
    Returns:
    
    the collection of keys whose value is the given value
  - replace
```
MutableHash<K,V> replace(K k,
                         V v)
```
    Description copied from interface: Hash
    
    Replaces the entry for the specified key only if it is currently mapped to some value.
    
    Specified by:
    
    replace in interface Hash<K,V>
    
    Parameters:
    
    k - key with which the specified value is associated
    
    v - value to be associated with the specified key
    
    Returns:
    
    a new hash after the entry is replaced
  - replace
```
MutableHash<K,V> replace(K k,
                         V oldValue,
                         V newValue)
```
    Description copied from interface: Hash
    
    Replaces the entry for the specified key only if currently mapped to the specified value.
    
    Specified by:
    
    replace in interface Hash<K,V>
    
    Parameters:
    
    k - 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
  - replaceAll
```
MutableHash<K,V> replaceAll(java.util.function.BiFunction<? super K,? super V,? extends V> function)
```
    Description copied from interface: Hash
    
    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.
    
    Specified by:
    
    replaceAll in interface Hash<K,V>
    
    Parameters:
    
    function - the function to apply to each entry
    
    Returns:
    
    a new hash after all the entries are replaced
  - putInPlace
```
MutableHash<K,V> putInPlace(K k,
                            V v)
```
    In-place method of #put(K, V)
  - putIfAbsentInPlace
```
MutableHash<K,V> putIfAbsentInPlace(K k,
                                    V v)
```
    In-place method of #putIfAbsent(K, V)
  - removeInPlace
```
MutableHash<K,V> removeInPlace(K k)
```
    In-place method of #remove(K)
  - removeInPlace
```
MutableHash<K,V> removeInPlace(K k,
                               V v)
```
    In-place method of #remove(K, V)
  - filterInPlace
```
MutableHash<K,V> filterInPlace(java.util.function.BiPredicate<K,V> condition)
```
    In-place method of filter(BiPredicate)
  - rejectInPlace
```
MutableHash<K,V> rejectInPlace(java.util.function.BiPredicate<K,V> condition)
```
    In-place method of reject(BiPredicate)
  - mergeInPlace
```
MutableHash<K,V> mergeInPlace(Hash<? extends K,? extends V> another)
```
    In-place method of merge(Hash)
  - clear
```
MutableHash<K,V> clear()
```
    Remove all the key-value pair at this hash.
    
    Returns:
    
    the hash itself after clear
  - replaceInPlace
```
MutableHash<K,V> replaceInPlace(K k,
                                V v)
```
    In-place method of #replace(K, V)
  - replaceInPlace
```
MutableHash<K,V> replaceInPlace(K k,
                                V oldValue,
                                V newValue)
```
    In-place method of #replace(K, V, V)
  - replaceAllInPlace
```
MutableHash<K,V> replaceAllInPlace(java.util.function.BiFunction<? super K,? super V,? extends V> function)
```
    In-place method of replaceAll(BiFunction)

Interface MutableHash<K,V>

Method Summary

Methods inherited from interface com.worksap.fig.lang.Hash

Method Detail

put

putIfAbsent

filter

reject

invert

merge

remove

remove

keysOf

replace

replace

replaceAll

putInPlace

putIfAbsentInPlace

removeInPlace

removeInPlace

filterInPlace

rejectInPlace

mergeInPlace

clear

replaceInPlace

replaceInPlace

replaceAllInPlace