|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.commons.collections4.map.Flat3Map<K,V>
public class Flat3Map<K,V>
A Map
implementation that stores data in simple fields until
the size is greater than 3.
This map is designed for performance and can outstrip HashMap. It also has good garbage collection characteristics.
The performance gains on puts are due to not needing to create a Map Entry object. This is a large saving not only in performance but in garbage collection.
Whilst in flat mode this map is also easy for the garbage collector to dispatch. This is because it contains no complex objects or arrays which slow the progress.
Do not use Flat3Map
if the size is likely to grow beyond 3.
Note that Flat3Map is not synchronized and is not thread-safe.
If you wish to use this map from multiple threads concurrently, you must use
appropriate synchronization. The simplest approach is to wrap this map
using Collections.synchronizedMap(Map)
. This class may throw
exceptions when accessed by concurrent threads without synchronization.
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface java.util.Map |
---|
Map.Entry<K,V> |
Constructor Summary | |
---|---|
Flat3Map()
Constructor. |
|
Flat3Map(Map<? extends K,? extends V> map)
Constructor copying elements from another map. |
Method Summary | |
---|---|
void |
clear()
Clears the map, resetting the size to zero and nullifying references to avoid garbage collection issues. |
Flat3Map<K,V> |
clone()
Clones the map without cloning the keys or values. |
boolean |
containsKey(Object key)
Checks whether the map contains the specified key. |
boolean |
containsValue(Object value)
Checks whether the map contains the specified value. |
protected AbstractHashedMap<K,V> |
createDelegateMap()
Create an instance of the map used for storage when in delegation mode. |
Set<Map.Entry<K,V>> |
entrySet()
Gets the entrySet view of the map. |
boolean |
equals(Object obj)
Compares this map with another. |
V |
get(Object key)
Gets the value mapped to the key specified. |
int |
hashCode()
Gets the standard Map hashCode. |
boolean |
isEmpty()
Checks whether the map is currently empty. |
Set<K> |
keySet()
Gets the keySet view of the map. |
MapIterator<K,V> |
mapIterator()
Gets an iterator over the map. |
V |
put(K key,
V value)
Puts a key-value mapping into this map. |
void |
putAll(Map<? extends K,? extends V> map)
Puts all the values from the specified map into this map. |
V |
remove(Object key)
Removes the specified mapping from this map. |
int |
size()
Gets the size of the map. |
String |
toString()
Gets the map as a String. |
Collection<V> |
values()
Gets the values view of the map. |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public Flat3Map()
public Flat3Map(Map<? extends K,? extends V> map)
map
- the map to copy
NullPointerException
- if the map is nullMethod Detail |
---|
public V get(Object key)
get
in interface Map<K,V>
get
in interface Get<K,V>
key
- the key
Map.get(Object)
public int size()
size
in interface Map<K,V>
size
in interface Get<K,V>
Map.size()
public boolean isEmpty()
isEmpty
in interface Map<K,V>
isEmpty
in interface Get<K,V>
Map.isEmpty()
public boolean containsKey(Object key)
containsKey
in interface Map<K,V>
containsKey
in interface Get<K,V>
key
- the key to search for
Map.containsKey(Object)
public boolean containsValue(Object value)
containsValue
in interface Map<K,V>
containsValue
in interface Get<K,V>
value
- the value to search for
Map.containsValue(Object)
public V put(K key, V value)
put
in interface Map<K,V>
put
in interface Put<K,V>
key
- the key to addvalue
- the value to add
Map.put(Object, Object)
public void putAll(Map<? extends K,? extends V> map)
putAll
in interface Map<K,V>
putAll
in interface Put<K,V>
map
- the map to add
NullPointerException
- if the map is nullMap.putAll(Map)
protected AbstractHashedMap<K,V> createDelegateMap()
This can be overridden by subclasses to provide a different map implementation. Not every AbstractHashedMap is suitable, identity and reference based maps would be poor choices.
public V remove(Object key)
remove
in interface Map<K,V>
remove
in interface Get<K,V>
key
- the mapping to remove
Map.remove(Object)
public void clear()
clear
in interface Map<K,V>
clear
in interface Put<K,V>
Map.clear()
public MapIterator<K,V> mapIterator()
A MapIterator returns the keys in the map. It also provides convenient methods to get the key and value, and set the value. It avoids the need to create an entrySet/keySet/values object. It also avoids creating the Map Entry object.
mapIterator
in interface IterableGet<K,V>
public Set<Map.Entry<K,V>> entrySet()
NOTE: from 4.0, the returned Map Entry will be an independent object and will
not change anymore as the iterator progresses. To avoid this additional object
creation and simply iterate through the entries, use mapIterator()
.
entrySet
in interface Map<K,V>
entrySet
in interface Get<K,V>
Map.entrySet()
public Set<K> keySet()
mapIterator()
.
keySet
in interface Map<K,V>
keySet
in interface Get<K,V>
Map.keySet()
public Collection<V> values()
mapIterator()
.
values
in interface Map<K,V>
values
in interface Get<K,V>
Map.values()
public Flat3Map<K,V> clone()
clone
in class Object
public boolean equals(Object obj)
equals
in interface Map<K,V>
equals
in class Object
obj
- the object to compare to
public int hashCode()
hashCode
in interface Map<K,V>
hashCode
in class Object
public String toString()
toString
in class Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |