|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Objectorg.apache.commons.collections.SequencedHashMap
A map of objects whose mapping entries are sequenced based on the order in which they were added. This data structure has fast O(1) search time, deletion time, and insertion time.
Although this map is sequenced, it cannot implement
List because of incompatible interface definitions.
The remove methods in List and Map have different return values
(see: List.remove(Object) and Map.remove(Object)).
This class is not thread safe. When a thread safe implementation is
required, use Collections.synchronizedMap(Map) as it is documented,
or use explicit synchronization controls.
LinkedMap,
ListOrderedMap,
Serialized Form| Constructor Summary | |
SequencedHashMap()
Deprecated. Construct a new sequenced hash map with default initial size and load factor. |
|
SequencedHashMap(int initialSize)
Deprecated. Construct a new sequenced hash map with the specified initial size and default load factor. |
|
SequencedHashMap(int initialSize,
float loadFactor)
Deprecated. Construct a new sequenced hash map with the specified initial size and load factor. |
|
SequencedHashMap(Map m)
Deprecated. Construct a new sequenced hash map and add all the elements in the specified map. |
|
| Method Summary | |
void |
clear()
Deprecated. Implements Map.clear(). |
Object |
clone()
Deprecated. Creates a shallow copy of this object, preserving the internal structure by copying only references. |
boolean |
containsKey(Object key)
Deprecated. Implements Map.containsKey(Object). |
boolean |
containsValue(Object value)
Deprecated. Implements Map.containsValue(Object). |
Set |
entrySet()
Deprecated. Implements Map.entrySet(). |
boolean |
equals(Object obj)
Deprecated. Implements Map.equals(Object). |
Object |
get(int index)
Deprecated. Gets the key at the specified index. |
Object |
get(Object o)
Deprecated. Implements Map.get(Object). |
Map.Entry |
getFirst()
Deprecated. Return the entry for the "oldest" mapping. |
Object |
getFirstKey()
Deprecated. Return the key for the "oldest" mapping. |
Object |
getFirstValue()
Deprecated. Return the value for the "oldest" mapping. |
Map.Entry |
getLast()
Deprecated. Return the entry for the "newest" mapping. |
Object |
getLastKey()
Deprecated. Return the key for the "newest" mapping. |
Object |
getLastValue()
Deprecated. Return the value for the "newest" mapping. |
Object |
getValue(int index)
Deprecated. Gets the value at the specified index. |
int |
hashCode()
Deprecated. Implements Map.hashCode(). |
int |
indexOf(Object key)
Deprecated. Gets the index of the specified key. |
boolean |
isEmpty()
Deprecated. Implements Map.isEmpty(). |
Iterator |
iterator()
Deprecated. Gets an iterator over the keys. |
Set |
keySet()
Deprecated. Implements Map.keySet(). |
int |
lastIndexOf(Object key)
Deprecated. Gets the last index of the specified key. |
Object |
put(Object key,
Object value)
Deprecated. Implements Map.put(Object, Object). |
void |
putAll(Map t)
Deprecated. Adds all the mappings in the specified map to this map, replacing any mappings that already exist (as per Map.putAll(Map)). |
void |
readExternal(ObjectInput in)
Deprecated. Deserializes this map from the given stream. |
Object |
remove(int index)
Deprecated. Removes the element at the specified index. |
Object |
remove(Object key)
Deprecated. Implements Map.remove(Object). |
List |
sequence()
Deprecated. Returns a List view of the keys rather than a set view. |
int |
size()
Deprecated. Implements Map.size(). |
String |
toString()
Deprecated. Provides a string representation of the entries within the map. |
Collection |
values()
Deprecated. Implements Map.values(). |
void |
writeExternal(ObjectOutput out)
Deprecated. Serializes this map to the given stream. |
| Methods inherited from class java.lang.Object |
finalize, getClass, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
public SequencedHashMap()
public SequencedHashMap(int initialSize)
initialSize - the initial size for the hash tableHashMap.HashMap(int)
public SequencedHashMap(int initialSize,
float loadFactor)
initialSize - the initial size for the hash tableloadFactor - the load factor for the hash table.HashMap.HashMap(int,float)public SequencedHashMap(Map m)
putAll(Map).
| Method Detail |
public int size()
Map.size().
size in interface Mappublic boolean isEmpty()
Map.isEmpty().
isEmpty in interface Mappublic boolean containsKey(Object key)
Map.containsKey(Object).
containsKey in interface Mappublic boolean containsValue(Object value)
Map.containsValue(Object).
containsValue in interface Mappublic Object get(Object o)
Map.get(Object).
get in interface Mappublic Map.Entry getFirst()
entrySet().iterator().next(), but this method provides an
optimized implementation.
null if the
map is empty.public Object getFirstKey()
getFirst().getKey(), but this method provides a slightly
optimized implementation.
null if the
map is empty.public Object getFirstValue()
getFirst().getValue(), but this method provides a slightly
optimized implementation.
null if the
map is empty.public Map.Entry getLast()
Object obj = null;
Iterator iter = entrySet().iterator();
while(iter.hasNext()) {
obj = iter.next();
}
return (Map.Entry)obj;
However, the implementation of this method ensures an O(1) lookup of the
last key rather than O(n).
null if the map
is empty.public Object getLastKey()
getLast().getKey(), but this method provides a slightly
optimized implementation.
null if the map is
empty.public Object getLastValue()
getLast().getValue(), but this method provides a slightly
optimized implementation.
null if the map
is empty.
public Object put(Object key,
Object value)
Map.put(Object, Object).
put in interface Mappublic Object remove(Object key)
Map.remove(Object).
remove in interface Mappublic void putAll(Map t)
Map.putAll(Map)). The order
in which the entries are added is determined by the iterator returned
from Map.entrySet() for the specified map.
putAll in interface Mapt - the mappings that should be added to this map.
NullPointerException - if t is nullpublic void clear()
Map.clear().
clear in interface Mappublic boolean equals(Object obj)
Map.equals(Object).
equals in interface Mappublic int hashCode()
Map.hashCode().
hashCode in interface Mappublic String toString()
entrySet().iterator() and
iterate over the entries in the map formatting them as appropriate.
public Set keySet()
Map.keySet().
keySet in interface Mappublic Collection values()
Map.values().
values in interface Mappublic Set entrySet()
Map.entrySet().
entrySet in interface Map
public Object clone()
throws CloneNotSupportedException
clone()'d. The cloned object maintains the same sequence.
CloneNotSupportedException - if clone is not supported by a
subclass.public Object get(int index)
index - the index to retrieve
ArrayIndexOutOfBoundsException - if the index is
< 0 or > the size of the map.public Object getValue(int index)
index - the index to retrieve
ArrayIndexOutOfBoundsException - if the index is
< 0 or > the size of the map.public int indexOf(Object key)
key - the key to find the index of
public Iterator iterator()
public int lastIndexOf(Object key)
key - the key to find the index of
public List sequence()
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 keySet()
keySet()public Object remove(int index)
index - The index of the object to remove.
key, or
null if none existed.
ArrayIndexOutOfBoundsException - if the index is
< 0 or > the size of the map.
public void readExternal(ObjectInput in)
throws IOException,
ClassNotFoundException
readExternal in interface Externalizablein - the stream to deserialize from
IOException - if the stream raises it
ClassNotFoundException - if the stream raises it
public void writeExternal(ObjectOutput out)
throws IOException
writeExternal in interface Externalizableout - the stream to serialize to
IOException - if the stream raises it
|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||