Class Char2ObjectRBTreeMap<V>

  • All Implemented Interfaces:
    Char2ObjectFunction<V>, Char2ObjectMap<V>, Char2ObjectSortedMap<V>, Function<java.lang.Character,​V>, java.io.Serializable, java.lang.Cloneable, java.util.function.Function<java.lang.Character,​V>, java.util.function.IntFunction<V>, java.util.Map<java.lang.Character,​V>, java.util.SortedMap<java.lang.Character,​V>

    public class Char2ObjectRBTreeMap<V>
    extends AbstractChar2ObjectSortedMap<V>
    implements java.io.Serializable, java.lang.Cloneable
    A type-specific red-black tree map with a fast, small-footprint implementation.

    The iterators provided by the views of this class are type-specific bidirectional iterators. Moreover, the iterator returned by iterator() can be safely cast to a type-specific list iterator.

    See Also:
    Serialized Form
    • Constructor Detail

      • Char2ObjectRBTreeMap

        public Char2ObjectRBTreeMap()
        Creates a new empty tree map.
      • Char2ObjectRBTreeMap

        public Char2ObjectRBTreeMap​(java.util.Comparator<? super java.lang.Character> c)
        Creates a new empty tree map with the given comparator.
        Parameters:
        c - a (possibly type-specific) comparator.
      • Char2ObjectRBTreeMap

        public Char2ObjectRBTreeMap​(java.util.Map<? extends java.lang.Character,​? extends V> m)
        Creates a new tree map copying a given map.
        Parameters:
        m - a Map to be copied into the new tree map.
      • Char2ObjectRBTreeMap

        public Char2ObjectRBTreeMap​(java.util.SortedMap<java.lang.Character,​V> m)
        Creates a new tree map copying a given sorted map (and its Comparator).
        Parameters:
        m - a SortedMap to be copied into the new tree map.
      • Char2ObjectRBTreeMap

        public Char2ObjectRBTreeMap​(Char2ObjectMap<? extends V> m)
        Creates a new tree map copying a given map.
        Parameters:
        m - a type-specific map to be copied into the new tree map.
      • Char2ObjectRBTreeMap

        public Char2ObjectRBTreeMap​(Char2ObjectSortedMap<V> m)
        Creates a new tree map copying a given sorted map (and its Comparator).
        Parameters:
        m - a type-specific sorted map to be copied into the new tree map.
      • Char2ObjectRBTreeMap

        public Char2ObjectRBTreeMap​(char[] k,
                                    V[] v,
                                    java.util.Comparator<? super java.lang.Character> c)
        Creates a new tree map using the elements of two parallel arrays and the given comparator.
        Parameters:
        k - the array of keys of the new tree map.
        v - the array of corresponding values in the new tree map.
        c - a (possibly type-specific) comparator.
        Throws:
        java.lang.IllegalArgumentException - if k and v have different lengths.
      • Char2ObjectRBTreeMap

        public Char2ObjectRBTreeMap​(char[] k,
                                    V[] v)
        Creates a new tree map using the elements of two parallel arrays.
        Parameters:
        k - the array of keys of the new tree map.
        v - the array of corresponding values in the new tree map.
        Throws:
        java.lang.IllegalArgumentException - if k and v have different lengths.
    • Method Detail

      • clear

        public void clear()
        Description copied from interface: Char2ObjectMap
        Removes all of the mappings from this map (optional operation). The map will be empty after this call returns.
        Specified by:
        clear in interface Char2ObjectMap<V>
        Specified by:
        clear in interface Function<java.lang.Character,​V>
        Specified by:
        clear in interface java.util.Map<java.lang.Character,​V>
        See Also:
        Map.clear()
      • size

        public int size()
        Description copied from interface: Char2ObjectMap
        Returns the number of key/value mappings in this map. If the map contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.
        Specified by:
        size in interface Char2ObjectMap<V>
        Specified by:
        size in interface Function<java.lang.Character,​V>
        Specified by:
        size in interface java.util.Map<java.lang.Character,​V>
        Returns:
        the number of key-value mappings in this map.
        See Also:
        Size64
      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface java.util.Map<java.lang.Character,​V>
        Overrides:
        isEmpty in class AbstractChar2ObjectMap<V>
      • keySet

        public CharSortedSet keySet()
        Returns a type-specific sorted set view of the keys contained in this map.

        In addition to the semantics of Map.keySet(), you can safely cast the set returned by this call to a type-specific sorted set interface.

        Specified by:
        keySet in interface Char2ObjectMap<V>
        Specified by:
        keySet in interface Char2ObjectSortedMap<V>
        Specified by:
        keySet in interface java.util.Map<java.lang.Character,​V>
        Specified by:
        keySet in interface java.util.SortedMap<java.lang.Character,​V>
        Overrides:
        keySet in class AbstractChar2ObjectSortedMap<V>
        Returns:
        a type-specific sorted set view of the keys contained in this map.
        See Also:
        Map.keySet()
      • values

        public ObjectCollection<V> values()
        Returns a type-specific collection view of the values contained in this map.

        In addition to the semantics of Map.values(), you can safely cast the collection returned by this call to a type-specific collection interface.

        Specified by:
        values in interface Char2ObjectMap<V>
        Specified by:
        values in interface Char2ObjectSortedMap<V>
        Specified by:
        values in interface java.util.Map<java.lang.Character,​V>
        Specified by:
        values in interface java.util.SortedMap<java.lang.Character,​V>
        Overrides:
        values in class AbstractChar2ObjectSortedMap<V>
        Returns:
        a type-specific collection view of the values contained in this map.
        See Also:
        Map.values()
      • comparator

        public CharComparator comparator()
        Description copied from interface: Char2ObjectSortedMap
        Returns the comparator associated with this sorted set, or null if it uses its keys' natural ordering.
        Specified by:
        comparator in interface Char2ObjectSortedMap<V>
        Specified by:
        comparator in interface java.util.SortedMap<java.lang.Character,​V>
        See Also:
        SortedMap.comparator()
      • subMap

        public Char2ObjectSortedMap<V> subMap​(char from,
                                              char to)
        Description copied from interface: Char2ObjectSortedMap
        Returns a view of the portion of this sorted map whose keys range from fromKey, inclusive, to toKey, exclusive.
        Specified by:
        subMap in interface Char2ObjectSortedMap<V>
        See Also:
        SortedMap.subMap(Object,Object)
      • clone

        public Char2ObjectRBTreeMap<V> clone()
        Returns a deep copy of this tree map.

        This method performs a deep copy of this tree map; the data stored in the set, however, is not cloned. Note that this makes a difference only for object keys.

        Returns:
        a deep copy of this tree map.