TrieMap (cyclops 10.3.2 API)

java.lang.Object
- cyclops.data.TrieMap<K,V>

All Implemented Interfaces:

Convert<Higher<Higher<DataWitness.trieMap,K>,V>>, Higher<Higher<DataWitness.trieMap,K>,V>, Higher2<DataWitness.trieMap,K,V>, Filters<Tuple2<K,V>>, Folds<Tuple2<K,V>>, BiTransformable<K,V>, Transformable<V>, PersistentMap<K,V>, OnEmpty<Tuple2<K,V>>, OnEmptySwitch<Tuple2<K,V>,ImmutableMap<K,V>>, ImmutableMap<K,V>, io.kindedj.Hk<Higher<DataWitness.trieMap,K>,V>, java.io.Serializable, java.lang.Iterable<Tuple2<K,V>>
```
public final class TrieMap<K,V>
extends java.lang.Object
implements ImmutableMap<K,V>, Higher2<DataWitness.trieMap,K,V>, java.io.Serializable
```
See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

TrieMap()

Constructors
Constructor and Description
`TrieMap()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<R1,R2> TrieMap<R1,R2>`	`bimap(java.util.function.BiFunction<? super K,? super V,? extends Tuple2<R1,R2>> map)`
`<R1,R2> TrieMap<R1,R2>`	`bimap(java.util.function.Function<? super K,? extends R1> fn1, java.util.function.Function<? super V,? extends R2> fn2)` Transform this BiTransformable, changing two value types at once.
`<K2,V2> TrieMap<K2,V2>`	`concatMap(java.util.function.BiFunction<? super K,? super V,? extends java.lang.Iterable<Tuple2<K2,V2>>> mapper)`
`boolean`	`contains(Tuple2<K,V> t)`
`boolean`	`containsKey(K key)`
`static <K,V> TrieMap<K,V>`	`empty()`
`boolean`	`equals(java.lang.Object o)`
`TrieMap<K,V>`	`filter(java.util.function.Predicate<? super Tuple2<K,V>> predicate)` Keep only elements for which the supplied predicates hold e.g.
`TrieMap<K,V>`	`filterKeys(java.util.function.Predicate<? super K> predicate)`
`TrieMap<K,V>`	`filterValues(java.util.function.Predicate<? super V> predicate)`
`<K2,V2> TrieMap<K2,V2>`	`flatMap(java.util.function.BiFunction<? super K,? super V,? extends ImmutableMap<K2,V2>> mapper)`
`static <K,V> TrieMap<K,V>`	`fromMap(java.util.Map<K,V> source)`
`static <K,V> TrieMap<K,V>`	`fromStream(java.util.stream.Stream<Tuple2<K,V>> stream)`
`Option<V>`	`get(K key)`
`V`	`getOrElse(K key, V alt)`
`V`	`getOrElseGet(K key, java.util.function.Supplier<? extends V> alt)`
`int`	`hashCode()`
`java.util.Iterator<Tuple2<K,V>>`	`iterator()`
`<R> TrieMap<K,R>`	`map(java.util.function.Function<? super V,? extends R> fn)` Transform this functor using the supplied transformation function
`<R> TrieMap<R,V>`	`mapKeys(java.util.function.Function<? super K,? extends R> map)`
`<R> TrieMap<K,R>`	`mapValues(java.util.function.Function<? super V,? extends R> map)`
`<K2,V2,K3,V3> DMap.Three<K,V,K2,V2,K3,V3>`	`merge(DMap.Two<K2,V2,K3,V3> two)`
`<K2,V2> DMap.Two<K,V,K2,V2>`	`merge(ImmutableMap<K2,V2> one)`
`static <K,V> TrieMap<K,V>`	`of(K k, V v)`
`static <K,V> TrieMap<K,V>`	`of(K k1, V v1, K k2, V v2)`
`TrieMap<K,V>`	`put(K key, V value)`
`TrieMap<K,V>`	`put(Tuple2<K,V> keyAndValue)`
`TrieMap<K,V>`	`putAll(PersistentMap<? extends K,? extends V> map)`
`TrieMap<K,V>`	`remove(K key)`
`TrieMap<K,V>`	`removeAll(K[] keys)`
`int`	`size()`
`ReactiveSeq<Tuple2<K,V>>`	`stream()`
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface cyclops.data.ImmutableMap
allMatch, bipeek, containsValue, filterNot, forEach2, forEach2, forEach3, forEach3, forEach4, forEach4, isEmpty, javaMap, keys, mkString, notNull, onEmpty, onEmptyGet, onEmptySwitch, onEmptyTry, peek, removeAllKeys, toLazySeq, toSeq, values

Methods inherited from interface com.oath.cyclops.types.foldable.Folds
anyMatch, atPercentile, bankersQueue, collect, collect, collect, collect, count, countDistinct, doubleStats, elementAt, endsWith, firstValue, foldLeft, foldLeft, foldLeft, foldLeft, foldLeft, foldLeft, foldMap, foldMap, foldMapRight, foldRight, foldRight, foldRight, groupBy, hashSet, headOption, indexOf, indexOfSlice, intStats, iterableTo, join, join, join, lastIndexOf, lastIndexOfSlice, lazySeq, longStats, maxBy, maxBy, maximum, mean, median, minBy, minBy, minimum, mode, noneMatch, nonEmptyList, occurances, populationVariance, print, print, printErr, printOut, scheduleStream, seq, single, single, singleOrElse, startsWith, stdDeviation, sumDouble, sumInt, sumLong, takeOne, toArray, toArray, toCollection, toHashMap, toHashMap, toList, toMap, toMap, toSet, treeSet, variance, vector, withPercentiles, xMatch

Methods inherited from interface com.oath.cyclops.types.Filters
ofType

Methods inherited from interface com.oath.cyclops.types.persistent.PersistentMap
equalTo, mapView

Methods inherited from interface java.lang.Iterable
forEach, spliterator

Methods inherited from interface com.oath.cyclops.hkt.Higher
applyHKT_, applyHKT, applyHKT

Methods inherited from interface com.oath.cyclops.hkt.Convert
convert

- Constructor Detail
  - TrieMap
```
public TrieMap()
```
- Method Detail
  - fromStream
```
public static <K,V> TrieMap<K,V> fromStream(java.util.stream.Stream<Tuple2<K,V>> stream)
```
  - of
```
public static <K,V> TrieMap<K,V> of(K k,
                                    V v)
```
  - of
```
public static <K,V> TrieMap<K,V> of(K k1,
                                    V v1,
                                    K k2,
                                    V v2)
```
  - fromMap
```
public static <K,V> TrieMap<K,V> fromMap(java.util.Map<K,V> source)
```
  - empty
```
public static <K,V> TrieMap<K,V> empty()
```
  - put
```
public TrieMap<K,V> put(K key,
                        V value)
```
    Specified by:
    
    put in interface PersistentMap<K,V>
    
    Specified by:
    
    put in interface ImmutableMap<K,V>
  - put
```
public TrieMap<K,V> put(Tuple2<K,V> keyAndValue)
```
    Specified by:
    
    put in interface PersistentMap<K,V>
    
    Specified by:
    
    put in interface ImmutableMap<K,V>
  - putAll
```
public TrieMap<K,V> putAll(PersistentMap<? extends K,? extends V> map)
```
    Specified by:
    
    putAll in interface PersistentMap<K,V>
    
    Specified by:
    
    putAll in interface ImmutableMap<K,V>
  - remove
```
public TrieMap<K,V> remove(K key)
```
    Specified by:
    
    remove in interface PersistentMap<K,V>
    
    Specified by:
    
    remove in interface ImmutableMap<K,V>
  - removeAll
```
public TrieMap<K,V> removeAll(K[] keys)
```
    Specified by:
    
    removeAll in interface ImmutableMap<K,V>
  - containsKey
```
public boolean containsKey(K key)
```
    Specified by:
    
    containsKey in interface PersistentMap<K,V>
    
    Specified by:
    
    containsKey in interface ImmutableMap<K,V>
  - contains
```
public boolean contains(Tuple2<K,V> t)
```
    Specified by:
    
    contains in interface PersistentMap<K,V>
    
    Specified by:
    
    contains in interface ImmutableMap<K,V>
  - get
```
public Option<V> get(K key)
```
    Specified by:
    
    get in interface PersistentMap<K,V>
    
    Specified by:
    
    get in interface ImmutableMap<K,V>
  - getOrElse
```
public V getOrElse(K key,
                   V alt)
```
    Specified by:
    
    getOrElse in interface PersistentMap<K,V>
    
    Specified by:
    
    getOrElse in interface ImmutableMap<K,V>
  - getOrElseGet
```
public V getOrElseGet(K key,
                      java.util.function.Supplier<? extends V> alt)
```
    Specified by:
    
    getOrElseGet in interface PersistentMap<K,V>
    
    Specified by:
    
    getOrElseGet in interface ImmutableMap<K,V>
  - size
```
public int size()
```
    Specified by:
    
    size in interface PersistentMap<K,V>
    
    Specified by:
    
    size in interface ImmutableMap<K,V>
  - merge
```
public <K2,V2> DMap.Two<K,V,K2,V2> merge(ImmutableMap<K2,V2> one)
```
    Specified by:
    
    merge in interface ImmutableMap<K,V>
  - merge
```
public <K2,V2,K3,V3> DMap.Three<K,V,K2,V2,K3,V3> merge(DMap.Two<K2,V2,K3,V3> two)
```
    Specified by:
    
    merge in interface ImmutableMap<K,V>
  - stream
```
public ReactiveSeq<Tuple2<K,V>> stream()
```
    Specified by:
    
    stream in interface Folds<Tuple2<K,V>>
    
    Specified by:
    
    stream in interface PersistentMap<K,V>
    
    Specified by:
    
    stream in interface ImmutableMap<K,V>
  - mapValues
```
public <R> TrieMap<K,R> mapValues(java.util.function.Function<? super V,? extends R> map)
```
    Specified by:
    
    mapValues in interface ImmutableMap<K,V>
  - mapKeys
```
public <R> TrieMap<R,V> mapKeys(java.util.function.Function<? super K,? extends R> map)
```
    Specified by:
    
    mapKeys in interface ImmutableMap<K,V>
  - bimap
```
public <R1,R2> TrieMap<R1,R2> bimap(java.util.function.BiFunction<? super K,? super V,? extends Tuple2<R1,R2>> map)
```
    Specified by:
    
    bimap in interface ImmutableMap<K,V>
  - flatMap
```
public <K2,V2> TrieMap<K2,V2> flatMap(java.util.function.BiFunction<? super K,? super V,? extends ImmutableMap<K2,V2>> mapper)
```
    Specified by:
    
    flatMap in interface ImmutableMap<K,V>
  - concatMap
```
public <K2,V2> TrieMap<K2,V2> concatMap(java.util.function.BiFunction<? super K,? super V,? extends java.lang.Iterable<Tuple2<K2,V2>>> mapper)
```
    Specified by:
    
    concatMap in interface ImmutableMap<K,V>
  - filter
```
public TrieMap<K,V> filter(java.util.function.Predicate<? super Tuple2<K,V>> predicate)
```
    Description copied from interface: Filters
    Keep only elements for which the supplied predicates hold e.g.
```
 

     of(1,2,3).filter(i->i>2);

     //[3]

 
 
```
    Specified by:
    
    filter in interface Filters<Tuple2<K,V>>
    
    Specified by:
    
    filter in interface ImmutableMap<K,V>
    
    Parameters:
    
    predicate - to filter elements by, retaining matches
    
    Returns:
    
    Filters with elements removed where the predicate does not hold
  - filterKeys
```
public TrieMap<K,V> filterKeys(java.util.function.Predicate<? super K> predicate)
```
    Specified by:
    
    filterKeys in interface ImmutableMap<K,V>
  - filterValues
```
public TrieMap<K,V> filterValues(java.util.function.Predicate<? super V> predicate)
```
    Specified by:
    
    filterValues in interface ImmutableMap<K,V>
  - map
```
public <R> TrieMap<K,R> map(java.util.function.Function<? super V,? extends R> fn)
```
    Description copied from interface: Transformable
    Transform this functor using the supplied transformation function
```
 


    of(1,2,3).map(i->i*2)

    //[2,4,6]

 
 
```
    Specified by:
    
    map in interface Transformable<V>
    
    Specified by:
    
    map in interface ImmutableMap<K,V>
    
    Parameters:
    
    fn - Transformation function
    
    Returns:
    
    Transformed Transformable
  - bimap
```
public <R1,R2> TrieMap<R1,R2> bimap(java.util.function.Function<? super K,? extends R1> fn1,
                                    java.util.function.Function<? super V,? extends R2> fn2)
```
    Description copied from interface: BiTransformable
    Transform this BiTransformable, changing two value types at once.
```
 
     MapX<String,Integer> map = MapXs.of("hello",2);
     MapX<String,Integer> transformedMap = map.bimap(s->s+" world",i->i*4);
     //["hello world",8]
 
 
```
    Specified by:
    
    bimap in interface BiTransformable<K,V>
    
    Specified by:
    
    bimap in interface ImmutableMap<K,V>
    
    Parameters:
    
    fn1 - transformation function for the first type
    
    fn2 - transformation function for the second type
    
    Returns:
    
    New BiTransformable containing transformed data
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - iterator
```
public java.util.Iterator<Tuple2<K,V>> iterator()
```
    Specified by:
    
    iterator in interface java.lang.Iterable<Tuple2<K,V>>
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object

Class TrieMap<K,V>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface cyclops.data.ImmutableMap

Methods inherited from interface com.oath.cyclops.types.foldable.Folds

Methods inherited from interface com.oath.cyclops.types.Filters

Methods inherited from interface com.oath.cyclops.types.persistent.PersistentMap

Methods inherited from interface java.lang.Iterable

Methods inherited from interface com.oath.cyclops.hkt.Higher

Methods inherited from interface com.oath.cyclops.hkt.Convert

Constructor Detail

TrieMap

Method Detail

fromStream

of

of

fromMap

empty

put

put

putAll

remove

removeAll

containsKey

contains

get

getOrElse

getOrElseGet

size

merge

merge

stream

mapValues

mapKeys

bimap

flatMap

concatMap

filter

filterKeys

filterValues

map

bimap

toString

iterator

equals

hashCode