Interface CharByteMap

    • Method Detail

      • get

        byte get​(char key)
        Retrieves the value associated with the key. If no mapping exists for the key, the default value (usually 0) is returned.
        Parameters:
        key - the key
        Returns:
        the value associated with the key, or the default value if no such mapping exists
      • getIfAbsent

        byte getIfAbsent​(char key,
                         byte ifAbsent)
        Retrieves the value associated with the key, returning the specified default value if no such mapping exists.
        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

        byte getOrThrow​(char key)
        Retrieves the value associated with the key, throwing an IllegalStateException if no such mapping exists.
        Parameters:
        key - the key
        Returns:
        the value associated with the key
        Throws:
        java.lang.IllegalStateException - if no mapping exists for the key
      • containsKey

        boolean containsKey​(char key)
        Returns whether or not the key is present in the map.
        Parameters:
        key - the key
        Returns:
        if a mapping exists in this map for the key
      • forEachKey

        void forEachKey​(CharProcedure procedure)
        Iterates through each key in the map, invoking the procedure for each.
        Parameters:
        procedure - the procedure to invoke for each key
      • forEachKeyValue

        void forEachKeyValue​(CharByteProcedure procedure)
        Iterates through each key/value pair in the map, invoking the procedure for each.
        Parameters:
        procedure - the procedure to invoke for each key/value pair
      • injectIntoKeyValue

        default <IV> IV injectIntoKeyValue​(IV injectedValue,
                                           ObjectCharByteToObjectFunction<? super IV,​? extends IV> function)
        Implements the injectInto pattern with each key/value pair of the map.
        Parameters:
        value - to be injected into the map
        function - to apply to the injected value and key/value pairs
        Returns:
        result of injecting the injectedValue into the map
        Since:
        11.1
      • keysView

        LazyCharIterable keysView()
        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.
        Returns:
        a view of the keys in this map
        Since:
        5.0
      • keyValuesView

        RichIterable<CharBytePair> keyValuesView()
        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.
        Returns:
        a view of the keys in this map
        Since:
        5.0
      • flipUniqueValues

        ByteCharMap flipUniqueValues()
        Return the ByteCharMap that is obtained by flipping the direction of this map and making the associations from value to key.
        Throws:
        java.lang.IllegalStateException - if the ByteCharMap contains duplicate values.
        Since:
        9.0
      • select

        CharByteMap select​(CharBytePredicate predicate)
        Return a copy of this map containing only the key/value pairs that match the predicate.
        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

        CharByteMap reject​(CharBytePredicate predicate)
        Return a copy of this map containing only the key/value pairs that do not match the predicate.
        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
      • equals

        boolean equals​(java.lang.Object o)
        Follows the same general contract as Map.equals(Object).
        Overrides:
        equals in class java.lang.Object
      • hashCode

        int hashCode()
        Follows the same general contract as Map.hashCode().
        Overrides:
        hashCode in class java.lang.Object
      • toString

        java.lang.String toString()
        Follows the same general contract as AbstractMap.toString()
        Specified by:
        toString in interface PrimitiveIterable
        Overrides:
        toString in class java.lang.Object
        Returns:
        a string representation of this CharByteMap
        See Also:
        AbstractCollection.toString()
      • toImmutable

        ImmutableCharByteMap toImmutable()
        Returns a copy of this map that is immutable (if this map is mutable) or itself if it is already immutable.
        Returns:
        an immutable map that is equivalent to this one
      • keySet

        MutableCharSet keySet()
        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.
        Returns:
        a mutable set containing the keys in this map