Package org.apache.pivot.collections.immutable

Class ImmutableMap<K,​V>

  • Type Parameters:
    K - Key type for the elements of this map.
    V - Value type for the map elements.
    All Implemented Interfaces:
    java.lang.Iterable<K>, Collection<K>, Dictionary<K,​V>, Map<K,​V>
    public final class ImmutableMap<K,​V>
extends java.lang.Object
implements Map<K,​V>
    Unmodifiable implementation of the Map interface.

    • Constructor Summary

      Constructors 
      Constructor Description
      ImmutableMap​(Map<K,​V> map)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void clear()
      Removes all entries in the map.
      boolean containsKey​(K key)
      Tests the existence of a key in the dictionary.
      V get​(K key)
      Retrieves the value for the given key.
      java.util.Comparator<K> getComparator()
      Returns the collection's sort order.
      int getCount()
      Returns the number of entries in the map.
      ListenerList<MapListener<K,​V>> getMapListeners()
      Returns the map listener collection.
      boolean isEmpty()
      Tests the emptiness of the collection.
      java.util.Iterator<K> iterator()  
      V put​(K key, V value)
      Sets the value of the given key, creating a new entry or replacing the existing value, and firing a corresponding event.
      V remove​(K key)
      Removes a key/value pair from the map.
      void setComparator​(java.util.Comparator<K> comparator)
      Sets the collection's sort order, re-ordering the collection's contents and ensuring that new entries preserve the sort order.
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

      • Methods inherited from interface java.lang.Iterable

        forEach, spliterator

    • Constructor Detail

      • ImmutableMap

        public ImmutableMap​(Map<K,​V> map)

    • Method Detail

      • get

        public V get​(K key)
        Description copied from interface: Dictionary
        Retrieves the value for the given key.
        Specified by:
        get in interface Dictionary<K,​V>
        Parameters:
        key - The key whose value is to be returned.
        Returns:
        The value corresponding to key, or null if the key does not exist. Will also return null if the key refers to a null value. Use Dictionary.containsKey(K) to distinguish between these two cases.

      • containsKey

        public boolean containsKey​(K key)
        Description copied from interface: Dictionary
        Tests the existence of a key in the dictionary.
        Specified by:
        containsKey in interface Dictionary<K,​V>
        Parameters:
        key - The key whose presence in the dictionary is to be tested.
        Returns:
        true if the key exists in the dictionary; false, otherwise.

      • isEmpty

        public boolean isEmpty()
        Description copied from interface: Collection
        Tests the emptiness of the collection.
        Specified by:
        isEmpty in interface Collection<K>
        Returns:
        true if the collection contains no elements; false, otherwise.

      • getCount

        public int getCount()
        Description copied from interface: Map
        Returns the number of entries in the map.
        Specified by:
        getCount in interface Map<K,​V>
        Returns:
        Current number of map entries.

      • getComparator

        public java.util.Comparator<K> getComparator()
        Description copied from interface: Collection
        Returns the collection's sort order.
        Specified by:
        getComparator in interface Collection<K>
        Returns:
        The comparator used to order elements in the collection, or null if the sort order is undefined.
        See Also:
        Collection.setComparator(Comparator)

      • setComparator

        @UnsupportedOperation
public void setComparator​(java.util.Comparator<K> comparator)
        Description copied from interface: Collection
        Sets the collection's sort order, re-ordering the collection's contents and ensuring that new entries preserve the sort order.

        Calling this method more than once with the same comparator will re-sort the collection.

        Specified by:
        setComparator in interface Collection<K>
        Specified by:
        setComparator in interface Map<K,​V>
        Parameters:
        comparator - The comparator used to order elements in the collection, or null if the collection is unsorted.
        See Also:
        MapListener.comparatorChanged(Map, Comparator)

      • iterator

        public java.util.Iterator<K> iterator()
        Specified by:
        iterator in interface java.lang.Iterable<K>

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • getMapListeners

        public ListenerList<MapListener<K,​V>> getMapListeners()
        Description copied from interface: Map
        Returns the map listener collection.
        Specified by:
        getMapListeners in interface Map<K,​V>
        Returns:
        Current list of listeners on this map.