|
Copyright 2008 - 2009 Tony Morris, Runar Bjarnason, Tom Adams, Brad Clow, Ricky Clarkson, Nick Partridge, Jason Zaugg This software is released under an open source BSD licence. |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfj.data.TreeMap<K,V>
public final class TreeMap<K,V>
An immutable, in-memory map, backed by a red-black tree.
Method Summary | ||
---|---|---|
boolean |
contains(K k)
Determines if the given key value exists in this tree map. |
|
TreeMap<K,V> |
delete(K k)
Deletes the entry in the tree map that corresponds to the given key. |
|
static
|
empty(Ord<K> keyOrd)
Constructs an empty tree map. |
|
static
|
fromMutableMap(Ord<K> ord,
Map<K,V> m)
An immutable projection of the given mutable map. |
|
F<K,Option<V>> |
get()
Returns a first-class version of the get method for this TreeMap. |
|
Option<V> |
get(K k)
Returns a potential value that the given key maps to. |
|
boolean |
isEmpty()
Determines if this tree map has any entries. |
|
Iterator<P2<K,V>> |
iterator()
Returns an iterator for this map's key-value pairs. |
|
List<K> |
keys()
Returns all keys in this tree map. |
|
|
map(F<V,W> f)
Maps the given function across the values of this TreeMap. |
|
TreeMap<K,V> |
set(K k,
V v)
Inserts the given key and value association into the tree map. |
|
int |
size()
Returns the number of entries in this tree map. |
|
P3<Set<V>,Option<V>,Set<V>> |
split(K k)
Splits this TreeMap at the given key. |
|
Map<K,V> |
toMutableMap()
A mutable map projection of this tree map. |
|
P2<Boolean,TreeMap<K,V>> |
update(K k,
F<V,V> f)
Modifies the value for the given key, if present, by applying the given function to it. |
|
TreeMap<K,V> |
update(K k,
F<V,V> f,
V v)
Modifies the value for the given key, if present, by applying the given function to it, or inserts the given value if the key is not present. |
|
List<V> |
values()
Returns all values in this tree map. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public static <K,V> TreeMap<K,V> empty(Ord<K> keyOrd)
keyOrd
- An order for the keys of the tree map.
public Option<V> get(K k)
k
- The key to look up in the tree map.
public TreeMap<K,V> set(K k, V v)
k
- The key to insert.v
- The value to insert.
public TreeMap<K,V> delete(K k)
k
- The key to delete from this tree map.
public int size()
public boolean isEmpty()
true
if this tree map has no entries, false
otherwise.public List<V> values()
public List<K> keys()
public boolean contains(K k)
k
- The key value to look for in this tree map.
true
if this tree map contains the given key, false
otherwise.public Iterator<P2<K,V>> iterator()
for
-each loop.
iterator
in interface Iterable<P2<K,V>>
public Map<K,V> toMutableMap()
public static <K,V> TreeMap<K,V> fromMutableMap(Ord<K> ord, Map<K,V> m)
ord
- An order for the map's keys.m
- A mutable map to project to an immutable one.
public F<K,Option<V>> get()
public P2<Boolean,TreeMap<K,V>> update(K k, F<V,V> f)
k
- The key for the value to modify.f
- A function with which to modify the value.
public TreeMap<K,V> update(K k, F<V,V> f, V v)
k
- The key for the value to modify.f
- A function with which to modify the value.v
- A value to associate with the given key if the key is not already present.
public P3<Set<V>,Option<V>,Set<V>> split(K k)
k
- A key at which to split this map.
public <W> TreeMap<K,W> map(F<V,W> f)
f
- A function to apply to the values of this TreeMap.
|
Copyright 2008 - 2009 Tony Morris, Runar Bjarnason, Tom Adams, Brad Clow, Ricky Clarkson, Nick Partridge, Jason Zaugg This software is released under an open source BSD licence. |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |