| org.apache.commons.collections.map.AbstractHashedMap
 org.apache.commons.collections.map.AbstractLinkedMap
org.apache.commons.collections.map.LinkedMap
| LinkedMap | | public class LinkedMap extends AbstractLinkedMap implements Serializable,Cloneable(Code) | | A Map implementation that maintains the order of the entries.
In this implementation order is maintained by original insertion.
This implementation improves on the JDK1.4 LinkedHashMap by adding the
org.apache.commons.collections.MapIterator MapIterator functionality, additional convenience methods and allowing
bidirectional iteration. It also implements OrderedMap.
In addition, non-interface methods are provided to access the map by index.
The orderedMapIterator() method provides direct access to a
bidirectional iterator. The iterators from the other views can also be cast
to OrderedIterator if required.
All the available iterators can be reset back to the start by casting to
ResettableIterator and calling reset().
The implementation is also designed to be subclassed, with lots of useful
methods exposed.
Note that LinkedMap 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
java.util.Collections.synchronizedMap(Map) . This class may throw
exceptions when accessed by concurrent threads without synchronization.
since:
Commons Collections 3.0
version:
$Revision: 348007 $ $Date: 2005-11-21 22:52:57 +0000 (Mon, 21 Nov 2005) $
author:
Stephen Colebourne |
| Inner Class :static class LinkedMapList extends AbstractList | |
| Constructor Summary | |
| public | LinkedMap()
Constructs a new empty map with default size and load factor. | | public | LinkedMap(int initialCapacity)
Constructs a new, empty map with the specified initial capacity. | | public | LinkedMap(int initialCapacity, float loadFactor)
Constructs a new, empty map with the specified initial capacity and
load factor. | | public | LinkedMap(Map map)
Constructor copying elements from another map. |
| Method Summary | |
| public List | asList()
Gets an unmodifiable List view of the keys.
The returned list is unmodifiable because changes to the values of
the list (using
java.util.ListIterator.set(Object) ) will
effectively remove the value from the list and reinsert that value at
the end of the list, which is an unexpected side effect of changing the
value of a list. | | public Object | clone()
Clones the map without cloning the keys or values. | | public Object | get(int index)
Gets the key at the specified index. | | public Object | getValue(int index)
Gets the value at the specified index. | | public int | indexOf(Object key)
Gets the index of the specified key. | | public Object | remove(int index)
Removes the element at the specified index. |
| LinkedMap | | public LinkedMap()(Code) | | Constructs a new empty map with default size and load factor.
|
| LinkedMap | | public LinkedMap(int initialCapacity)(Code) | | Constructs a new, empty map with the specified initial capacity.
Parameters:
initialCapacity - the initial capacity
throws:
IllegalArgumentException - if the initial capacity is less than one |
| LinkedMap | | public LinkedMap(int initialCapacity, float loadFactor)(Code) | | Constructs a new, empty map with the specified initial capacity and
load factor.
Parameters:
initialCapacity - the initial capacity
Parameters:
loadFactor - the load factor
throws:
IllegalArgumentException - if the initial capacity is less than one
throws:
IllegalArgumentException - if the load factor is less than zero |
| LinkedMap | | public LinkedMap(Map map)(Code) | | Constructor copying elements from another map.
Parameters:
map - the map to copy
throws:
NullPointerException - if the map is null |
| asList | | public List asList()(Code) | | Gets an unmodifiable List view of the keys.
The returned list is unmodifiable because changes to the values of
the list (using
java.util.ListIterator.set(Object) ) will
effectively remove the value from the list and reinsert that value at
the end of the list, which is an unexpected side effect of changing the
value of a list. This occurs because changing the key, changes when the
mapping is added to the map and thus where it appears in the list.
An alternative to this method is to use
LinkedMap.keySet() .
See Also: LinkedMap.keySet() The ordered list of keys. |
| clone | | public Object clone()(Code) | | Clones the map without cloning the keys or values.
a shallow clone |
| get | | public Object get(int index)(Code) | | Gets the key at the specified index.
Parameters:
index - the index to retrieve the key at the specified index
throws:
IndexOutOfBoundsException - if the index is invalid |
| getValue | | public Object getValue(int index)(Code) | | Gets the value at the specified index.
Parameters:
index - the index to retrieve the key at the specified index
throws:
IndexOutOfBoundsException - if the index is invalid |
| indexOf | | public int indexOf(Object key)(Code) | | Gets the index of the specified key.
Parameters:
key - the key to find the index of the index, or -1 if not found |
| remove | | public Object remove(int index)(Code) | | Removes the element at the specified index.
Parameters:
index - the index of the object to remove the previous value corresponding the key,or null if none existed
throws:
IndexOutOfBoundsException - if the index is invalid |
| Fields inherited from org.apache.commons.collections.map.AbstractLinkedMap | protected transient LinkEntry header(Code)(Java Doc)
|
| Methods inherited from org.apache.commons.collections.map.AbstractHashedMap | protected void addEntry(HashEntry entry, int hashIndex)(Code)(Java Doc)
protected void addMapping(int hashIndex, int hashCode, Object key, Object value)(Code)(Java Doc)
protected int calculateNewCapacity(int proposedCapacity)(Code)(Java Doc)
protected int calculateThreshold(int newCapacity, float factor)(Code)(Java Doc)
protected void checkCapacity()(Code)(Java Doc)
public void clear()(Code)(Java Doc)
protected Object clone()(Code)(Java Doc)
public boolean containsKey(Object key)(Code)(Java Doc)
public boolean containsValue(Object value)(Code)(Java Doc)
protected Object convertKey(Object key)(Code)(Java Doc)
protected HashEntry createEntry(HashEntry next, int hashCode, Object key, Object value)(Code)(Java Doc)
protected Iterator createEntrySetIterator()(Code)(Java Doc)
protected Iterator createKeySetIterator()(Code)(Java Doc)
protected Iterator createValuesIterator()(Code)(Java Doc)
protected void destroyEntry(HashEntry entry)(Code)(Java Doc)
protected void doReadObject(ObjectInputStream in) throws IOException, ClassNotFoundException(Code)(Java Doc)
protected void doWriteObject(ObjectOutputStream out) throws IOException(Code)(Java Doc)
protected void ensureCapacity(int newCapacity)(Code)(Java Doc)
protected int entryHashCode(HashEntry entry)(Code)(Java Doc)
protected Object entryKey(HashEntry entry)(Code)(Java Doc)
protected HashEntry entryNext(HashEntry entry)(Code)(Java Doc)
public Set entrySet()(Code)(Java Doc)
protected Object entryValue(HashEntry entry)(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
public Object get(Object key)(Code)(Java Doc)
protected HashEntry getEntry(Object key)(Code)(Java Doc)
protected int hash(Object key)(Code)(Java Doc)
public int hashCode()(Code)(Java Doc)
protected int hashIndex(int hashCode, int dataSize)(Code)(Java Doc)
protected void init()(Code)(Java Doc)
public boolean isEmpty()(Code)(Java Doc)
protected boolean isEqualKey(Object key1, Object key2)(Code)(Java Doc)
protected boolean isEqualValue(Object value1, Object value2)(Code)(Java Doc)
public Set keySet()(Code)(Java Doc)
public MapIterator mapIterator()(Code)(Java Doc)
public Object put(Object key, Object value)(Code)(Java Doc)
public void putAll(Map map)(Code)(Java Doc)
public Object remove(Object key)(Code)(Java Doc)
protected void removeEntry(HashEntry entry, int hashIndex, HashEntry previous)(Code)(Java Doc)
protected void removeMapping(HashEntry entry, int hashIndex, HashEntry previous)(Code)(Java Doc)
protected void reuseEntry(HashEntry entry, int hashIndex, int hashCode, Object key, Object value)(Code)(Java Doc)
public int size()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
protected void updateEntry(HashEntry entry, Object newValue)(Code)(Java Doc)
public Collection values()(Code)(Java Doc)
|
|
|