|
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.HashMap<K,V>
public final class HashMap<K,V>
A mutable hash map providing O(1) lookup.
HashMap
Constructor Summary | |
---|---|
HashMap(Equal<K> e,
Hash<K> h)
Construct a hash map with the given equality and hashing strategy. |
|
HashMap(Equal<K> e,
Hash<K> h,
int initialCapacity)
Construct a hash map with the given equality and hashing strategy. |
|
HashMap(Equal<K> e,
Hash<K> h,
int initialCapacity,
float loadFactor)
Construct a hash map with the given equality and hashing strategy. |
Method Summary | ||
---|---|---|
void |
clear()
Clear all entries from this hash map. |
|
boolean |
contains(K k)
Determines if the given key value exists in this hash map. |
|
void |
delete(K k)
Deletes the entry in the hash map that corresponds to the given key. |
|
boolean |
eq(K k1,
K k2)
Compare two key values for equality using the underlying equality strategy. |
|
F<K,Option<V>> |
get()
A curried version of get(Object) . |
|
Option<V> |
get(K k)
Returns a potential value that the given key maps to. |
|
Option<V> |
getDelete(K k)
Deletes the entry in the hash map that corresponds to the given key and returns any associated value. |
|
int |
hash(K k)
Compute the hash of the given key value using the underlying hashing strategy. |
|
static
|
hashMap()
Construct a hash map that uses Object.equals(java.lang.Object) and Object.hashCode() . |
|
boolean |
isEmpty()
Determines if this hash map has any entries. |
|
Iterator<K> |
iterator()
Returns an iterator for this map's keys. |
|
List<K> |
keys()
Returns all key entries in this hash map. |
|
void |
set(K k,
V v)
Inserts the given key and value association into the hash map. |
|
int |
size()
Returns the number of entries in this hash map. |
|
Collection<P2<K,V>> |
toCollection()
Projects an immutable collection of this hash map. |
|
List<V> |
values()
Returns all values in this hash map. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public HashMap(Equal<K> e, Hash<K> h)
e
- The equality strategy.h
- The hashing strategy.public HashMap(Equal<K> e, Hash<K> h, int initialCapacity)
e
- The equality strategy.h
- The hashing strategy.initialCapacity
- The initial capacity.public HashMap(Equal<K> e, Hash<K> h, int initialCapacity, float loadFactor)
e
- The equality strategy.h
- The hashing strategy.initialCapacity
- The initial capacity.loadFactor
- The load factor.Method Detail |
---|
public Iterator<K> iterator()
for
-each loop.
iterator
in interface Iterable<K>
public static <K,V> HashMap<K,V> hashMap()
Object.equals(java.lang.Object)
and Object.hashCode()
.
Object.equals(java.lang.Object)
and Object.hashCode()
.public boolean eq(K k1, K k2)
k1
- One key value to compare.k2
- The other key value to compare.
true
if the two key values are equal, false
otherwise.public int hash(K k)
k
- The key value to computer the hash of.
public Option<V> get(K k)
k
- The key to look up in the hash map.
public F<K,Option<V>> get()
get(Object)
.
get(Object)
.public void clear()
public boolean contains(K k)
k
- The key value to look for in this hash map.
true
if this hash map contains the given key, false
otherwise.public List<K> keys()
public List<V> values()
public boolean isEmpty()
true
if this hash map has no entries, false
otherwise.public int size()
public void set(K k, V v)
k
- The key to insert.v
- The value to insert.public void delete(K k)
k
- The key to delete from this hash map.public Option<V> getDelete(K k)
k
- The key to delete from this hash map.
public Collection<P2<K,V>> toCollection()
|
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 |