Package dev.brachtendorf.datastructures

Class CircularLinkedHashMap<K,​V>

  • Type Parameters:
    K - the type of keys maintained by this map
    V - the type of mapped values
    All Implemented Interfaces:
    Serializable, Cloneable, Map<K,​V>
    public class CircularLinkedHashMap<K,​V>
extends LinkedHashMap<K,​V>

    A linked hashmap only keeping the newest n entries. Useful for caching.

    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.)

    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 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.synchronizedMap method. This is best done at creation time, to prevent accidental unsynchronized access to the map: 

       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 method 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.

    The spliterators returned by the spliterator method of the collections returned by all of this class's collection view methods are late-binding, fail-fast, and additionally report Spliterator.ORDERED.

    This class is a member of the Java Collections Framework.

    Since:
    1.0.0 com.github.kilianB
    Author:
    Kilian
    See Also:
    Serialized Form

    • Constructor Detail

      • CircularLinkedHashMap

        public CircularLinkedHashMap​(int bufferSize)
        Constructs an empty insertion-ordered CircularLinkedHashMap
        Parameters:
        bufferSize - the initial capacity. When exceeding the capacity the oldest element will be removed
        Throws:
        IllegalArgumentException - if the initial capacity is negative

      • CircularLinkedHashMap

        public CircularLinkedHashMap​(int bufferSize,
                             boolean accessOrder)
        Constructs an empty CircularLinkedHashMap instance
        Parameters:
        bufferSize - the initial capacity. When exceeding the capacity the oldest element will be removed
        accessOrder - the ordering mode - true for access-order, false for insertion-order
        Throws:
        IllegalArgumentException - if the bufferSize is non positive

      • CircularLinkedHashMap

        public CircularLinkedHashMap​(Map<? extends K,​? extends V> m)

        Constructs an insertion-ordered CircularLinkedHashMap instance with the same mappings as the specified map. The CircularLinkedHashMap instance is created with a default buffer size of 12.

        If a different buffer size is required use another constructor and invoke the putAll() method to batch insert all elements. Be aware that this method is only deterministic for maps with a specified order. Else random elements may be present in this hashmap after the insertion is finished depending on the order of the elements returned by the itterator.

        Parameters:
        m - the map whose mappings are to be placed in this map
        Throws:
        NullPointerException - if the specified map is null