com.ideaheap.barelyfunctional.data

Class BfMaps

java.lang.Object

com.ideaheap.barelyfunctional.data.BfMaps

public class BfMaps
extends Object

An immutable map library. Convenience functions for dealing with maps and entries.

Constructor Summary

Constructors

Constructor and Description
BfMaps()

Method Summary

Modifier and Type	Method and Description
static <K,V> Map<K,V>	assoc(Map<K,V> map, K key, V val) Update or replace key with val.
static <K,V> Map<K,V>	assoc(Map<K,V> map, Map.Entry<K,V>... entries) Update or replace with e(key, val)
static <K,V> Map<K,V>	assoc(Map<K,V> map, Map<K,V> upsertMap) Update map with content from upsertMap.
static <K,V> Map<K,V>	dissoc(Map<K,V> map, K... keys) Drop the keys specified from the map specified
static <K,V> Map.Entry<K,V>	e(K key, V val) Create an entry with key : val.
static <K,V> Map<K,V>	map(Map.Entry<K,V>... entries) Create a map with the specified entries.
static <K,V> Map<K,V>	merge(Map<K,V>... maps) merges N maps.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BfMaps

public BfMaps()

Method Detail

merge

public static <K,V> Map<K,V> merge(Map<K,V>... maps)

merges N maps. The expectation here is that there are no duplicate keys between maps. An exception will be thrown if there is. If you want that functionality, use the assoc method.

Parameters:

maps - the maps to merge

Returns:

A map containing the elements from all maps it was given merged together.

assoc

public static <K,V> Map<K,V> assoc(Map<K,V> map,
                                   Map.Entry<K,V>... entries)

Update or replace with e(key, val)

Parameters:

map - The map to update

entries - The entries to add to the map.

Returns:

A map with the entries either added or updated to it from the original map.

assoc

public static <K,V> Map<K,V> assoc(Map<K,V> map,
                                   Map<K,V> upsertMap)

Update map with content from upsertMap.

Parameters:

map - The map to update.

upsertMap - The map to source for updates.

Returns:

An updated map with the elements specified updated or added.

dissoc

public static <K,V> Map<K,V> dissoc(Map<K,V> map,
                                    K... keys)

Drop the keys specified from the map specified

Parameters:

map - The map to start from.

keys - The keys to remove

Returns:

A copy of map that has the keys specified removed from it.

map

public static <K,V> Map<K,V> map(Map.Entry<K,V>... entries)

Create a map with the specified entries.

Parameters:

entries - the entries to add to the map.

Returns:

A map with the entries specified.

assoc

public static <K,V> Map<K,V> assoc(Map<K,V> map,
                                   K key,
                                   V val)

Update or replace key with val.

Parameters:

map - The map to create an updated version of

key - The key to either update or add.

val - The value to place at this key.

Returns:

An updated map with key : val added / updated.

e

public static <K,V> Map.Entry<K,V> e(K key,
                                     V val)

Create an entry with key : val.

Parameters:

key - The key.

val - The value.

Returns:

A map entry with key, value.