Class ImmutableByteCharHashMap

java.lang.Object
org.eclipse.collections.impl.map.immutable.primitive.ImmutableByteCharHashMap
All Implemented Interfaces:
Serializable, CharIterable, ByteCharMap, CharValuesMap, ImmutableByteCharMap, PrimitiveIterable
final class ImmutableByteCharHashMap extends Object implements ImmutableByteCharMap, Serializable
ImmutableByteCharHashMap is the non-modifiable equivalent of ByteCharHashMap. This file was automatically generated from template file immutablePrimitivePrimitiveHashMap.stg.
Since:
4.0.

  • Field Details

  • Constructor Details

    • ImmutableByteCharHashMap

      ImmutableByteCharHashMap(ByteCharMap delegate)

  • Method Details

    • get

      public char get(byte key)
      Description copied from interface: ByteCharMap
      Retrieves the value associated with the key. If no mapping exists for the key, the default value (usually 0) is returned.
      Specified by:
      get in interface ByteCharMap
      Parameters:
      key - the key
      Returns:
      the value associated with the key, or the default value if no such mapping exists

    • getIfAbsent

      public char getIfAbsent(byte key, char ifAbsent)
      Description copied from interface: ByteCharMap
      Retrieves the value associated with the key, returning the specified default value if no such mapping exists.
      Specified by:
      getIfAbsent in interface ByteCharMap
      Parameters:
      key - the key
      ifAbsent - the default value to return if no mapping exists for key
      Returns:
      the value associated with the key, or ifAbsent if no such mapping exists.

    • getOrThrow

      public char getOrThrow(byte key)
      Description copied from interface: ByteCharMap
      Retrieves the value associated with the key, throwing an IllegalStateException if no such mapping exists.
      Specified by:
      getOrThrow in interface ByteCharMap
      Parameters:
      key - the key
      Returns:
      the value associated with the key

    • containsKey

      public boolean containsKey(byte key)
      Description copied from interface: ByteCharMap
      Returns whether or not the key is present in the map.
      Specified by:
      containsKey in interface ByteCharMap
      Parameters:
      key - the key
      Returns:
      if a mapping exists in this map for the key

    • containsValue

      public boolean containsValue(char value)
      Description copied from interface: CharValuesMap
      Returns whether or not this map contains the value.
      Specified by:
      containsValue in interface CharValuesMap
      Parameters:
      value - the value to test
      Returns:
      if this collection contains the value

    • forEachValue

      public void forEachValue(CharProcedure procedure)
      Description copied from interface: CharValuesMap
      Iterates through each value in this map.
      Specified by:
      forEachValue in interface CharValuesMap
      Parameters:
      procedure - the procedure to invoke for each value in this map.

    • forEachKey

      public void forEachKey(ByteProcedure procedure)
      Description copied from interface: ByteCharMap
      Iterates through each key in the map, invoking the procedure for each.
      Specified by:
      forEachKey in interface ByteCharMap
      Parameters:
      procedure - the procedure to invoke for each key

    • forEachKeyValue

      public void forEachKeyValue(ByteCharProcedure procedure)
      Description copied from interface: ByteCharMap
      Iterates through each key/value pair in the map, invoking the procedure for each.
      Specified by:
      forEachKeyValue in interface ByteCharMap
      Parameters:
      procedure - the procedure to invoke for each key/value pair

    • allSatisfyKeyValue

      public boolean allSatisfyKeyValue(ByteCharPredicate predicate)
      Specified by:
      allSatisfyKeyValue in interface ByteCharMap
      Since:
      12.0

    • keysView

      public LazyByteIterable keysView()
      Description copied from interface: ByteCharMap
      Returns a view of the keys in this map. This iterable is backed by the map, so any modifications to the underlying map will be reflected in the keys returned by the iterable.
      Specified by:
      keysView in interface ByteCharMap
      Returns:
      a view of the keys in this map

    • keyValuesView

      public RichIterable<ByteCharPair> keyValuesView()
      Description copied from interface: ByteCharMap
      Returns a view of the key/value pairs in this map. This iterable is backed by the map, so any modifications to the underlying map will be reflected in the pairs returned by the iterable.
      Specified by:
      keyValuesView in interface ByteCharMap
      Returns:
      a view of the keys in this map

    • flipUniqueValues

      public ImmutableCharByteMap flipUniqueValues()
      Description copied from interface: ByteCharMap
      Return the CharByteMap that is obtained by flipping the direction of this map and making the associations from value to key.
      Specified by:
      flipUniqueValues in interface ByteCharMap
      Specified by:
      flipUniqueValues in interface ImmutableByteCharMap

    • select

      public ImmutableByteCharMap select(ByteCharPredicate predicate)
      Description copied from interface: ByteCharMap
      Return a copy of this map containing only the key/value pairs that match the predicate.
      Specified by:
      select in interface ByteCharMap
      Specified by:
      select in interface ImmutableByteCharMap
      Parameters:
      predicate - the predicate to determine which key/value pairs in this map should be included in the returned map
      Returns:
      a copy of this map with the matching key/value pairs

    • reject

      public ImmutableByteCharMap reject(ByteCharPredicate predicate)
      Description copied from interface: ByteCharMap
      Return a copy of this map containing only the key/value pairs that do not match the predicate.
      Specified by:
      reject in interface ByteCharMap
      Specified by:
      reject in interface ImmutableByteCharMap
      Parameters:
      predicate - the predicate to determine which key/value pairs in this map should be excluded from the returned map
      Returns:
      a copy of this map without the matching key/value pairs

    • injectInto

      public <T> T injectInto(T injectedValue, ObjectCharToObjectFunction<? super T, ? extends T> function)
      Specified by:
      injectInto in interface CharIterable

    • chunk

      public RichIterable<CharIterable> chunk(int size)
      Description copied from interface: CharIterable
      Partitions elements in fixed size chunks.
      Specified by:
      chunk in interface CharIterable
      Parameters:
      size - the number of elements per chunk
      Returns:
      A RichIterable containing CharIterables of size size, except the last will be truncated if the elements don't divide evenly.

    • toImmutable

      public ImmutableByteCharMap toImmutable()
      Description copied from interface: ByteCharMap
      Returns a copy of this map that is immutable (if this map is mutable) or itself if it is already immutable.
      Specified by:
      toImmutable in interface ByteCharMap
      Returns:
      an immutable map that is equivalent to this one

    • charIterator

      public CharIterator charIterator()
      Description copied from interface: CharIterable
      Returns a primitive iterator that can be used to iterate over the CharIterable in an imperative style.
      Specified by:
      charIterator in interface CharIterable

    • each

      public void each(CharProcedure procedure)
      Description copied from interface: CharIterable
      A synonym for forEach.
      Specified by:
      each in interface CharIterable
      Since:
      7.0.

    • count

      public int count(CharPredicate predicate)
      Description copied from interface: CharIterable
      Returns a count of the number of elements in the CharIterable that return true for the specified predicate.
      Specified by:
      count in interface CharIterable

    • anySatisfy

      public boolean anySatisfy(CharPredicate predicate)
      Description copied from interface: CharIterable
      Returns true if any of the elements in the CharIterable return true for the specified predicate, otherwise returns false.
      Specified by:
      anySatisfy in interface CharIterable

    • allSatisfy

      public boolean allSatisfy(CharPredicate predicate)
      Description copied from interface: CharIterable
      Returns true if all of the elements in the CharIterable return true for the specified predicate, otherwise returns false.
      Specified by:
      allSatisfy in interface CharIterable

    • noneSatisfy

      public boolean noneSatisfy(CharPredicate predicate)
      Description copied from interface: CharIterable
      Returns true if none of the elements in the CharIterable return true for the specified predicate, otherwise returns false.
      Specified by:
      noneSatisfy in interface CharIterable

    • select

      public ImmutableCharBag select(CharPredicate predicate)
      Description copied from interface: CharIterable
      Returns a new CharIterable with all of the elements in the CharIterable that return true for the specified predicate.
      Specified by:
      select in interface CharIterable
      Specified by:
      select in interface CharValuesMap
      Specified by:
      select in interface ImmutableByteCharMap

    • reject

      public ImmutableCharBag reject(CharPredicate predicate)
      Description copied from interface: CharIterable
      Returns a new CharIterable with all of the elements in the CharIterable that return false for the specified predicate.
      Specified by:
      reject in interface CharIterable
      Specified by:
      reject in interface CharValuesMap
      Specified by:
      reject in interface ImmutableByteCharMap

    • collect

      public <V> ImmutableBag<V> collect(CharToObjectFunction<? extends V> function)
      Description copied from interface: CharIterable
      Returns a new collection with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.
      Specified by:
      collect in interface CharIterable
      Specified by:
      collect in interface CharValuesMap
      Specified by:
      collect in interface ImmutableByteCharMap

    • detectIfNone

      public char detectIfNone(CharPredicate predicate, char ifNone)
      Specified by:
      detectIfNone in interface CharIterable

    • sum

      public long sum()
      Specified by:
      sum in interface CharIterable

    • max

      public char max()
      Specified by:
      max in interface CharIterable

    • maxIfEmpty

      public char maxIfEmpty(char defaultValue)
      Specified by:
      maxIfEmpty in interface CharIterable

    • min

      public char min()
      Specified by:
      min in interface CharIterable

    • minIfEmpty

      public char minIfEmpty(char defaultValue)
      Specified by:
      minIfEmpty in interface CharIterable

    • average

      public double average()
      Specified by:
      average in interface CharIterable

    • median

      public double median()
      Specified by:
      median in interface CharIterable

    • toSortedArray

      public char[] toSortedArray()
      Specified by:
      toSortedArray in interface CharIterable

    • toSortedList

      public MutableCharList toSortedList()
      Specified by:
      toSortedList in interface CharIterable

    • toArray

      public char[] toArray()
      Description copied from interface: CharIterable
      Converts the CharIterable to a primitive char array.
      Specified by:
      toArray in interface CharIterable

    • toArray

      public char[] toArray(char[] target)
      Description copied from interface: CharIterable
      Converts the CharIterable to a primitive char array. If the collection fits into the provided array it is used to store its elements and is returned from the method, otherwise a new array of the appropriate size is allocated and returned. If the iterable is empty, the target array is returned unchanged.
      Specified by:
      toArray in interface CharIterable

    • contains

      public boolean contains(char value)
      Description copied from interface: CharIterable
      Returns true if the value is contained in the CharIterable, and false if it is not.
      Specified by:
      contains in interface CharIterable

    • containsAll

      public boolean containsAll(char... source)
      Description copied from interface: CharIterable
      Returns true if all of the values specified in the source array are contained in the CharIterable, and false if they are not.
      Specified by:
      containsAll in interface CharIterable

    • containsAll

      public boolean containsAll(CharIterable source)
      Description copied from interface: CharIterable
      Returns true if all of the values specified in the source CharIterable are contained in the CharIterable, and false if they are not.
      Specified by:
      containsAll in interface CharIterable

    • toList

      public MutableCharList toList()
      Description copied from interface: CharIterable
      Converts the CharIterable to a new MutableCharList.
      Specified by:
      toList in interface CharIterable

    • toSet

      public MutableCharSet toSet()
      Description copied from interface: CharIterable
      Converts the CharIterable to a new MutableCharSet.
      Specified by:
      toSet in interface CharIterable

    • toBag

      public MutableCharBag toBag()
      Description copied from interface: CharIterable
      Converts the CharIterable to a new MutableCharBag.
      Specified by:
      toBag in interface CharIterable

    • asLazy

      public LazyCharIterable asLazy()
      Description copied from interface: CharIterable
      Returns a LazyCharIterable adapter wrapping the source CharIterable.
      Specified by:
      asLazy in interface CharIterable

    • newWithKeyValue

      public ImmutableByteCharMap newWithKeyValue(byte key, char value)
      Description copied from interface: ImmutableByteCharMap
      Copy this map, associate the value with the key (replacing the value if one already exists for key), and return the copy as new immutable map. A copy is always made even if key is already associated with value.
      Specified by:
      newWithKeyValue in interface ImmutableByteCharMap
      Parameters:
      key - the key to add
      value - the value to associate with the key in the copy
      Returns:
      an immutable copy of this map with value associated with key

    • newWithoutKey

      public ImmutableByteCharMap newWithoutKey(byte key)
      Description copied from interface: ImmutableByteCharMap
      Copy this map, remove any associated value with the key (if one exists), and return the copy as a new immutable map.
      Specified by:
      newWithoutKey in interface ImmutableByteCharMap
      Parameters:
      key - the key to remove
      Returns:
      an immutable copy of this map with key removed

    • newWithoutAllKeys

      public ImmutableByteCharMap newWithoutAllKeys(ByteIterable keys)
      Description copied from interface: ImmutableByteCharMap
      Copy this map, remove any associated values with the specified keys (if any exist), and return the copy as a new immutable map.
      Specified by:
      newWithoutAllKeys in interface ImmutableByteCharMap
      Parameters:
      keys - the keys to remove
      Returns:
      an immutable copy of this map with all keys in keys removed

    • size

      public int size()
      Description copied from interface: PrimitiveIterable
      Returns the number of items in this iterable.
      Specified by:
      size in interface PrimitiveIterable

    • isEmpty

      public boolean isEmpty()
      Description copied from interface: PrimitiveIterable
      Returns true if this iterable has zero items.
      Specified by:
      isEmpty in interface PrimitiveIterable

    • notEmpty

      public boolean notEmpty()
      Description copied from interface: PrimitiveIterable
      The English equivalent of !this.isEmpty()
      Specified by:
      notEmpty in interface PrimitiveIterable

    • makeString

      public String makeString()
      Description copied from interface: PrimitiveIterable
      Returns a string representation of this collection by delegating to PrimitiveIterable.makeString(String) and defaulting the separator parameter to the characters ", " (comma and space).
      Specified by:
      makeString in interface PrimitiveIterable
      Returns:
      a string representation of this collection.

    • makeString

      public String makeString(String separator)
      Description copied from interface: PrimitiveIterable
      Returns a string representation of this collection by delegating to PrimitiveIterable.makeString(String, String, String) and defaulting the start and end parameters to "" (the empty String).
      Specified by:
      makeString in interface PrimitiveIterable
      Returns:
      a string representation of this collection.

    • makeString

      public String makeString(String start, String separator, String end)
      Description copied from interface: PrimitiveIterable
      Returns a string representation of this collection with the elements separated by the specified separator and enclosed between the start and end strings.
      Specified by:
      makeString in interface PrimitiveIterable
      Returns:
      a string representation of this collection.

    • appendString

      public void appendString(Appendable appendable)
      Description copied from interface: PrimitiveIterable
      Prints a string representation of this collection onto the given Appendable. Prints the string returned by PrimitiveIterable.makeString().
      Specified by:
      appendString in interface PrimitiveIterable

    • appendString

      public void appendString(Appendable appendable, String separator)
      Description copied from interface: PrimitiveIterable
      Prints a string representation of this collection onto the given Appendable. Prints the string returned by PrimitiveIterable.makeString(String).
      Specified by:
      appendString in interface PrimitiveIterable

    • appendString

      public void appendString(Appendable appendable, String start, String separator, String end)
      Description copied from interface: PrimitiveIterable
      Prints a string representation of this collection onto the given Appendable. Prints the string returned by PrimitiveIterable.makeString(String, String, String).
      Specified by:
      appendString in interface PrimitiveIterable

    • keySet

      public MutableByteSet keySet()
      Description copied from interface: ByteCharMap
      Returns a set containing all the keys in this map. The set is backed by the map, so any modifications to the returned set will affect this map.
      Specified by:
      keySet in interface ByteCharMap
      Returns:
      a mutable set containing the keys in this map

    • values

      public MutableCharCollection values()
      Description copied from interface: CharValuesMap
      Returns the values in this map as a separate collection. The returned collection is backed by the map, so any changes made to the returned collection will affect the state of this map.
      Specified by:
      values in interface CharValuesMap
      Returns:
      the values as a collection backed by this map

    • equals

      public boolean equals(Object obj)
      Description copied from interface: ByteCharMap
      Follows the same general contract as Map.equals(Object).
      Specified by:
      equals in interface ByteCharMap
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Description copied from interface: ByteCharMap
      Follows the same general contract as Map.hashCode().
      Specified by:
      hashCode in interface ByteCharMap
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Description copied from interface: ByteCharMap
      Follows the same general contract as AbstractMap.toString()
      Specified by:
      toString in interface ByteCharMap
      Specified by:
      toString in interface PrimitiveIterable
      Overrides:
      toString in class Object
      Returns:
      a string representation of this ByteCharMap
      See Also:

    • writeReplace

      private Object writeReplace()