Java Doc for LinkedHashMap.java in  » 6.0-JDK-Modules » j2me » java » util » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » 6.0 JDK Modules » j2me » java.util 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   java.util.AbstractMap
      java.util.HashMap
         java.util.LinkedHashMap

LinkedHashMap
public class LinkedHashMap extends HashMap (Code)

Hash table and linked list implementation of the Map interface, with predictable iteration order. This implementation differs from HashMap in that it maintains a doubly-linked list running through all of its entries. This linked list defines the iteration ordering, which is normally the order in which keys were inserted into the map (insertion-order). Note that insertion order is not affected if a key is re-inserted into the map. (A key k is reinserted into a map m if m.put(k, v) is invoked when m.containsKey(k) would return true immediately prior to the invocation.)

This implementation spares its clients from the unspecified, generally chaotic ordering provided by HashMap (and Hashtable ), without incurring the increased cost associated with TreeMap . It can be used to produce a copy of a map that has the same order as the original, regardless of the original map's implementation:

 void foo(Map m) {
 Map copy = new LinkedHashMap(m);
 ...
 }
 
This technique is particularly useful if a module takes a map on input, copies it, and later returns results whose order is determined by that of the copy. (Clients generally appreciate having things returned in the same order they were presented.)

A special LinkedHashMap.LinkedHashMap(int,float,boolean) constructor is provided to create a linked hash map whose order of iteration is the order in which its entries were last accessed, from least-recently accessed to most-recently (access-order). This kind of map is well-suited to building LRU caches. Invoking the put or get method results in an access to the corresponding entry (assuming it exists after the invocation completes). The putAll method generates one entry access for each mapping in the specified map, in the order that key-value mappings are provided by the specified map's entry set iterator. No other methods generate entry accesses. In particular, operations on collection-views do not affect the order of iteration of the backing map.

The LinkedHashMap.removeEldestEntry(Map.Entry) method may be overridden to impose a policy for removing stale mappings automatically when new mappings are added to the map.

This class provides all of the optional Map operations, and permits null elements. Like HashMap, it provides constant-time performance for the basic operations (add, contains and remove), assuming the the hash function disperses elements properly among the buckets. Performance is likely to be just slightly below that of HashMap, due to the added expense of maintaining the linked list, with one exception: Iteration over the collection-views of a LinkedHashMap requires time proportional to the size of the map, regardless of its capacity. Iteration over a HashMap is likely to be more expensive, requiring time proportional to its capacity.

A linked hash map has two parameters that affect its performance: initial capacity and load factor. They are defined precisely as for HashMap. Note, however, that the penalty for choosing an excessively high value for initial capacity is less severe for this class than for HashMap, as iteration times for this class are unaffected by capacity.

Note that this implementation is not synchronized. If multiple threads access a linked hash map concurrently, and at least one of the threads modifies the map structurally, it must be synchronized externally. This is typically accomplished by synchronizing on some object that naturally encapsulates the map. If no such object exists, the map should be "wrapped" using the Collections.synchronizedMapmethod. This is best done at creation time, to prevent accidental unsynchronized access:

 Map m = Collections.synchronizedMap(new LinkedHashMap(...));
 
A structural modification is any operation that adds or deletes one or more mappings or, in the case of access-ordered linked hash maps, affects iteration order. In insertion-ordered linked hash maps, merely changing the value associated with a key that is already contained in the map is not a structural modification. In access-ordered linked hash maps, merely querying the map with get is a structural modification.)

The iterators returned by the iterator methods of the collections returned by all of this class's collection view methods are fail-fast: if the map is structurally modified at any time after the iterator is created, in any way except through the iterator's own remove method, the iterator will throw a ConcurrentModificationException. Thus, in the face of concurrent modification, the Iterator fails quickly and cleanly, rather than risking arbitrary, non-deterministic behavior at an undetermined time in the future.

Note that the fail-fast behavior of an iterator cannot be guaranteed as it is, generally speaking, impossible to make any hard guarantees in the presence of unsynchronized concurrent modification. Fail-fast iterators throw ConcurrentModificationException on a best-effort basis. Therefore, it would be wrong to write a program that depended on this exception for its correctness: the fail-fast behavior of iterators should be used only to detect bugs.

This class is a member of the Java Collections Framework.
author:
   Josh Bloch
version:
   1.14, 10/10/06
See Also:   Object.hashCode
See Also:   Collection
See Also:   Map
See Also:   HashMap
See Also:   TreeMap
See Also:   Hashtable
since:
   JDK1.4




Constructor Summary
public  LinkedHashMap(int initialCapacity, float loadFactor)
     Constructs an empty insertion-ordered LinkedHashMap instance with the specified initial capacity and load factor.
public  LinkedHashMap(int initialCapacity)
     Constructs an empty insertion-ordered LinkedHashMap instance with the specified initial capacity and a default load factor (0.75).
public  LinkedHashMap()
     Constructs an empty insertion-ordered LinkedHashMap instance with a default capacity (16) and load factor (0.75).
public  LinkedHashMap(Map m)
     Constructs an insertion-ordered LinkedHashMap instance with the same mappings as the specified map.
public  LinkedHashMap(int initialCapacity, float loadFactor, boolean accessOrder)
     Constructs an empty LinkedHashMap instance with the specified initial capacity, load factor and ordering mode.

Method Summary
 voidaddEntry(int hash, Object key, Object value, int bucketIndex)
     This override alters behavior of superclass put method.
public  voidclear()
     Removes all mappings from this map.
public  booleancontainsValue(Object value)
     Returns true if this map maps one or more keys to the specified value.
Parameters:
  value - value whose presence in this map is to be tested.
 voidcreateEntry(int hash, Object key, Object value, int bucketIndex)
     This override differs from addEntry in that it doesn't resize the table or remove the eldest entry.
public  Objectget(Object key)
     Returns the value to which this map maps the specified key.
 voidinit()
     Called by superclass constructors and pseudoconstructors (clone, readObject) before any entries are inserted into the map.
 IteratornewEntryIterator()
    
 IteratornewKeyIterator()
    
 IteratornewValueIterator()
    
protected  booleanremoveEldestEntry(Map.Entry eldest)
     Returns true if this map should remove its eldest entry. This method is invoked by put and putAll after inserting a new entry into the map.
 voidtransfer(HashMap.Entry[] newTable)
     Transfer all entries to new table array.


Constructor Detail
LinkedHashMap
public LinkedHashMap(int initialCapacity, float loadFactor)(Code)
Constructs an empty insertion-ordered LinkedHashMap instance 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 negativeor the load factor is nonpositive.



LinkedHashMap
public LinkedHashMap(int initialCapacity)(Code)
Constructs an empty insertion-ordered LinkedHashMap instance with the specified initial capacity and a default load factor (0.75).
Parameters:
  initialCapacity - the initial capacity.
throws:
  IllegalArgumentException - if the initial capacity is negative.



LinkedHashMap
public LinkedHashMap()(Code)
Constructs an empty insertion-ordered LinkedHashMap instance with a default capacity (16) and load factor (0.75).



LinkedHashMap
public LinkedHashMap(Map m)(Code)
Constructs an insertion-ordered LinkedHashMap instance with the same mappings as the specified map. The LinkedHashMap instance is created with a a default load factor (0.75) and an initial capacity sufficient to hold the mappings in the specified map.
Parameters:
  m - the map whose mappings are to be placed in this map.
throws:
  NullPointerException - if the specified map is null.



LinkedHashMap
public LinkedHashMap(int initialCapacity, float loadFactor, boolean accessOrder)(Code)
Constructs an empty LinkedHashMap instance with the specified initial capacity, load factor and ordering mode.
Parameters:
  initialCapacity - the initial capacity.
Parameters:
  loadFactor - the load factor.
Parameters:
  accessOrder - the ordering mode - true foraccess-order, false for insertion-order.
throws:
  IllegalArgumentException - if the initial capacity is negativeor the load factor is nonpositive.




Method Detail
addEntry
void addEntry(int hash, Object key, Object value, int bucketIndex)(Code)
This override alters behavior of superclass put method. It causes newly allocated entry to get inserted at the end of the linked list and removes the eldest entry if appropriate.



clear
public void clear()(Code)
Removes all mappings from this map.



containsValue
public boolean containsValue(Object value)(Code)
Returns true if this map maps one or more keys to the specified value.
Parameters:
  value - value whose presence in this map is to be tested. true if this map maps one or more keys to thespecified value.



createEntry
void createEntry(int hash, Object key, Object value, int bucketIndex)(Code)
This override differs from addEntry in that it doesn't resize the table or remove the eldest entry.



get
public Object get(Object key)(Code)
Returns the value to which this map maps the specified key. Returns null if the map contains no mapping for this key. A return value of null does not necessarily indicate that the map contains no mapping for the key; it's also possible that the map explicitly maps the key to null. The containsKey operation may be used to distinguish these two cases. the value to which this map maps the specified key.
Parameters:
  key - key whose associated value is to be returned.



init
void init()(Code)
Called by superclass constructors and pseudoconstructors (clone, readObject) before any entries are inserted into the map. Initializes the chain.



newEntryIterator
Iterator newEntryIterator()(Code)



newKeyIterator
Iterator newKeyIterator()(Code)



newValueIterator
Iterator newValueIterator()(Code)



removeEldestEntry
protected boolean removeEldestEntry(Map.Entry eldest)(Code)
Returns true if this map should remove its eldest entry. This method is invoked by put and putAll after inserting a new entry into the map. It provides the implementer with the opportunity to remove the eldest entry each time a new one is added. This is useful if the map represents a cache: it allows the map to reduce memory consumption by deleting stale entries.

Sample use: this override will allow the map to grow up to 100 entries and then delete the eldest entry each time a new entry is added, maintaining a steady state of 100 entries.

 private static final int MAX_ENTRIES = 100;
 protected boolean removeEldestEntry(Map.Entry eldest) {
 return size() > MAX_ENTRIES;
 }
 

This method typically does not modify the map in any way, instead allowing the map to modify itself as directed by its return value. It is permitted for this method to modify the map directly, but if it does so, it must return false (indicating that the map should not attempt any further modification). The effects of returning true after modifying the map from within this method are unspecified.

This implementation merely returns false (so that this map acts like a normal map - the eldest element is never removed).
Parameters:
  eldest - The least recently inserted entry in the map, or if this is an access-ordered map, the least recently accessedentry. This is the entry that will be removed it thismethod returns true. If the map was empty priorto the put or putAll invocation resultingin this invocation, this will be the entry that was justinserted; in other words, if the map contains a singleentry, the eldest entry is also the newest. true if the eldest entry should be removedfrom the map; false if it should be retained.




transfer
void transfer(HashMap.Entry[] newTable)(Code)
Transfer all entries to new table array. This method is called by superclass resize. It is overridden for performance, as it is faster to iterate using our linked list.



Fields inherited from java.util.HashMap
final static int DEFAULT_INITIAL_CAPACITY(Code)(Java Doc)
final static float DEFAULT_LOAD_FACTOR(Code)(Java Doc)
final static int MAXIMUM_CAPACITY(Code)(Java Doc)
final static Object NULL_KEY(Code)(Java Doc)
final float loadFactor(Code)(Java Doc)
transient volatile int modCount(Code)(Java Doc)
transient int size(Code)(Java Doc)
transient Entry[] table(Code)(Java Doc)
int threshold(Code)(Java Doc)

Methods inherited from java.util.HashMap
void addEntry(int hash, Object key, Object value, int bucketIndex)(Code)(Java Doc)
int capacity()(Code)(Java Doc)
public void clear()(Code)(Java Doc)
public Object clone()(Code)(Java Doc)
public boolean containsKey(Object key)(Code)(Java Doc)
public boolean containsValue(Object value)(Code)(Java Doc)
void createEntry(int hash, Object key, Object value, int bucketIndex)(Code)(Java Doc)
public Set entrySet()(Code)(Java Doc)
static boolean eq(Object x, Object y)(Code)(Java Doc)
public Object get(Object key)(Code)(Java Doc)
Entry getEntry(Object key)(Code)(Java Doc)
static int hash(Object x)(Code)(Java Doc)
static int indexFor(int h, int length)(Code)(Java Doc)
void init()(Code)(Java Doc)
public boolean isEmpty()(Code)(Java Doc)
public Set keySet()(Code)(Java Doc)
float loadFactor()(Code)(Java Doc)
static Object maskNull(Object key)(Code)(Java Doc)
Iterator newEntryIterator()(Code)(Java Doc)
Iterator newKeyIterator()(Code)(Java Doc)
Iterator newValueIterator()(Code)(Java Doc)
public Object put(Object key, Object value)(Code)(Java Doc)
public void putAll(Map m)(Code)(Java Doc)
void putAllForCreate(Map m)(Code)(Java Doc)
public Object remove(Object key)(Code)(Java Doc)
Entry removeEntryForKey(Object key)(Code)(Java Doc)
Entry removeMapping(Object o)(Code)(Java Doc)
void resize(int newCapacity)(Code)(Java Doc)
public int size()(Code)(Java Doc)
void transfer(Entry[] newTable)(Code)(Java Doc)
static Object unmaskNull(Object key)(Code)(Java Doc)
public Collection values()(Code)(Java Doc)

Fields inherited from java.util.AbstractMap
transient volatile Set keySet(Code)(Java Doc)
transient volatile Collection values(Code)(Java Doc)

Methods inherited from java.util.AbstractMap
public void clear()(Code)(Java Doc)
protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean containsKey(Object key)(Code)(Java Doc)
public boolean containsValue(Object value)(Code)(Java Doc)
abstract public Set entrySet()(Code)(Java Doc)
public boolean equals(Object o)(Code)(Java Doc)
public Object get(Object key)(Code)(Java Doc)
public int hashCode()(Code)(Java Doc)
public boolean isEmpty()(Code)(Java Doc)
public Set keySet()(Code)(Java Doc)
public Object put(Object key, Object value)(Code)(Java Doc)
public void putAll(Map t)(Code)(Java Doc)
public Object remove(Object key)(Code)(Java Doc)
public int size()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
public Collection values()(Code)(Java Doc)

Methods inherited from java.lang.Object
public boolean equals(Object obj)(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.