Class Char2ByteRBTreeMap

All Implemented Interfaces:
Char2ByteFunction, Char2ByteMap, Char2ByteSortedMap, Function<java.lang.Character,​java.lang.Byte>, java.io.Serializable, java.lang.Cloneable, java.util.function.Function<java.lang.Character,​java.lang.Byte>, java.util.function.IntUnaryOperator, java.util.Map<java.lang.Character,​java.lang.Byte>, java.util.SortedMap<java.lang.Character,​java.lang.Byte>

public class Char2ByteRBTreeMap
extends AbstractChar2ByteSortedMap
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 Details

    • Char2ByteRBTreeMap

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

      public Char2ByteRBTreeMap​(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.
    • Char2ByteRBTreeMap

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

      public Char2ByteRBTreeMap​(java.util.SortedMap<java.lang.Character,​java.lang.Byte> 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.
    • Char2ByteRBTreeMap

      public Char2ByteRBTreeMap​(Char2ByteMap m)
      Creates a new tree map copying a given map.
      Parameters:
      m - a type-specific map to be copied into the new tree map.
    • Char2ByteRBTreeMap

      public Char2ByteRBTreeMap​(Char2ByteSortedMap 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.
    • Char2ByteRBTreeMap

      public Char2ByteRBTreeMap​(char[] k, byte[] 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.
    • Char2ByteRBTreeMap

      public Char2ByteRBTreeMap​(char[] k, byte[] 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 Details

    • addTo

      public byte addTo​(char k, byte incr)
      Adds an increment to value currently associated with a key.

      Note that this method respects the default return value semantics: when called with a key that does not currently appears in the map, the key will be associated with the default return value plus the given increment.

      Parameters:
      k - the key.
      incr - the increment.
      Returns:
      the old value, or the default return value if no value was present for the given key.
    • put

      public byte put​(char k, byte v)
      Description copied from interface: Char2ByteFunction
      Adds a pair to the map (optional operation).
      Specified by:
      put in interface Char2ByteFunction
      Parameters:
      k - the key.
      v - the value.
      Returns:
      the old value, or the default return value if no value was present for the given key.
      See Also:
      Function.put(Object,Object)
    • remove

      public byte remove​(char k)
      Description copied from interface: Char2ByteFunction
      Removes the mapping with the given key (optional operation).
      Specified by:
      remove in interface Char2ByteFunction
      Parameters:
      k - the key.
      Returns:
      the old value, or the default return value if no value was present for the given key.
      See Also:
      Function.remove(Object)
    • containsValue

      public boolean containsValue​(byte v)
      Description copied from class: AbstractChar2ByteMap
      Returns true if this map maps one or more keys to the specified value.
      Specified by:
      containsValue in interface Char2ByteMap
      Overrides:
      containsValue in class AbstractChar2ByteMap
      See Also:
      Map.containsValue(Object)
    • clear

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

      public boolean containsKey​(char k)
      Description copied from class: AbstractChar2ByteMap
      Returns true if this function contains a mapping for the specified key.
      Specified by:
      containsKey in interface Char2ByteFunction
      Specified by:
      containsKey in interface Char2ByteMap
      Overrides:
      containsKey in class AbstractChar2ByteMap
      Parameters:
      k - the key.
      Returns:
      true if this function associates a value to key.
      See Also:
      Map.containsKey(Object)
    • size

      public int size()
      Description copied from interface: Char2ByteMap
      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 Char2ByteMap
      Specified by:
      size in interface Function<java.lang.Character,​java.lang.Byte>
      Specified by:
      size in interface java.util.Map<java.lang.Character,​java.lang.Byte>
      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,​java.lang.Byte>
      Overrides:
      isEmpty in class AbstractChar2ByteMap
    • get

      public byte get​(char k)
      Description copied from interface: Char2ByteFunction
      Returns the value to which the given key is mapped.
      Specified by:
      get in interface Char2ByteFunction
      Parameters:
      k - the key.
      Returns:
      the corresponding value, or the default return value if no value was present for the given key.
      See Also:
      Function.get(Object)
    • firstCharKey

      public char firstCharKey()
      Description copied from interface: Char2ByteSortedMap
      Returns the first (lowest) key currently in this map.
      Specified by:
      firstCharKey in interface Char2ByteSortedMap
      See Also:
      SortedMap.firstKey()
    • lastCharKey

      public char lastCharKey()
      Description copied from interface: Char2ByteSortedMap
      Returns the last (highest) key currently in this map.
      Specified by:
      lastCharKey in interface Char2ByteSortedMap
      See Also:
      SortedMap.lastKey()
    • char2ByteEntrySet

      public ObjectSortedSet<Char2ByteMap.Entry> char2ByteEntrySet()
      Description copied from interface: Char2ByteSortedMap
      Returns a type-specific sorted-set view of the mappings contained in this map.
      Specified by:
      char2ByteEntrySet in interface Char2ByteMap
      Specified by:
      char2ByteEntrySet in interface Char2ByteSortedMap
      Returns:
      a type-specific sorted-set view of the mappings contained in this map.
      See Also:
      Char2ByteSortedMap.entrySet()
    • 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 Char2ByteMap
      Specified by:
      keySet in interface Char2ByteSortedMap
      Specified by:
      keySet in interface java.util.Map<java.lang.Character,​java.lang.Byte>
      Specified by:
      keySet in interface java.util.SortedMap<java.lang.Character,​java.lang.Byte>
      Overrides:
      keySet in class AbstractChar2ByteSortedMap
      Returns:
      a type-specific sorted set view of the keys contained in this map.
      See Also:
      Map.keySet()
    • values

      public ByteCollection 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 Char2ByteMap
      Specified by:
      values in interface Char2ByteSortedMap
      Specified by:
      values in interface java.util.Map<java.lang.Character,​java.lang.Byte>
      Specified by:
      values in interface java.util.SortedMap<java.lang.Character,​java.lang.Byte>
      Overrides:
      values in class AbstractChar2ByteSortedMap
      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: Char2ByteSortedMap
      Returns the comparator associated with this sorted set, or null if it uses its keys' natural ordering.
      Specified by:
      comparator in interface Char2ByteSortedMap
      Specified by:
      comparator in interface java.util.SortedMap<java.lang.Character,​java.lang.Byte>
      See Also:
      SortedMap.comparator()
    • headMap

      public Char2ByteSortedMap headMap​(char to)
      Description copied from interface: Char2ByteSortedMap
      Returns a view of the portion of this sorted map whose keys are strictly less than toKey.
      Specified by:
      headMap in interface Char2ByteSortedMap
      See Also:
      SortedMap.headMap(Object)
    • tailMap

      public Char2ByteSortedMap tailMap​(char from)
      Description copied from interface: Char2ByteSortedMap
      Returns a view of the portion of this sorted map whose keys are greater than or equal to fromKey.
      Specified by:
      tailMap in interface Char2ByteSortedMap
      See Also:
      SortedMap.tailMap(Object)
    • subMap

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

      public Char2ByteRBTreeMap 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.