Interface Char2BooleanFunction

    • Method Summary

      Modifier and Type Method Description
      default boolean containsKey​(char key)
      Returns true if this function contains a mapping for the specified key.
      default boolean containsKey​(Object key)
      Deprecated.
      Please use the corresponding type-specific method instead.
      default boolean defaultReturnValue()
      Gets the default return value.
      default void defaultReturnValue​(boolean rv)
      Sets the default return value (optional operation).
      boolean get​(char key)
      Returns the value to which the given key is mapped.
      default Boolean get​(Object key)
      Deprecated.
      Please use the corresponding type-specific method instead.
      default boolean put​(char key, boolean value)
      Adds a pair to the map (optional operation).
      default Boolean put​(Character key, Boolean value)
      Deprecated.
      Please use the corresponding type-specific method instead.
      default boolean remove​(char key)
      Removes the mapping with the given key (optional operation).
      default Boolean remove​(Object key)
      Deprecated.
      Please use the corresponding type-specific method instead.
      default boolean test​(int operand)
      Deprecated.
      Please use primitive types which don't have to be widened as keys.
    • Method Detail

      • test

        @Deprecated
        default boolean test​(int operand)
        Deprecated.
        Please use primitive types which don't have to be widened as keys.

        In this default implementation, the key gets narrowed down to the actual key type, throwing an exception if the given key can't be represented in the restricted domain. This is done for interoperability with the Java 8 function environment. Its use is discouraged, as unexpected errors can occur. Instead, the corresponding classes should be used (e.g., Int2IntFunction instead of Short2IntFunction).

        Specified by:
        test in interface IntPredicate
        Throws:
        IllegalArgumentException - If the given operand is not an element of the key domain.
        Since:
        8.0.0
      • put

        default boolean put​(char key,
                            boolean value)
        Adds a pair to the map (optional operation).
        Parameters:
        key - the key.
        value - 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)
      • get

        boolean get​(char key)
        Returns the value to which the given key is mapped.
        Parameters:
        key - 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)
      • remove

        default boolean remove​(char key)
        Removes the mapping with the given key (optional operation).
        Parameters:
        key - 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)
      • put

        @Deprecated
        default Boolean put​(Character key,
                            Boolean value)
        Deprecated.
        Please use the corresponding type-specific method instead.
        Associates the specified value with the specified key in this function (optional operation).
        Specified by:
        put in interface Function<Character,​Boolean>
        Parameters:
        key - the key.
        value - the value.
        Returns:
        the old value, or null if no value was present for the given key.
        See Also:
        Map.put(Object,Object)
      • get

        @Deprecated
        default Boolean get​(Object key)
        Deprecated.
        Please use the corresponding type-specific method instead.
        Returns the value associated by this function to the specified key.
        Specified by:
        get in interface Function<Character,​Boolean>
        Parameters:
        key - the key.
        Returns:
        the corresponding value, or null if no value was present for the given key.
        See Also:
        Map.get(Object)
      • remove

        @Deprecated
        default Boolean remove​(Object key)
        Deprecated.
        Please use the corresponding type-specific method instead.
        Removes this key and the associated value from this function if it is present (optional operation).
        Specified by:
        remove in interface Function<Character,​Boolean>
        Parameters:
        key - the key.
        Returns:
        the old value, or null if no value was present for the given key.
        See Also:
        Map.remove(Object)
      • containsKey

        default boolean containsKey​(char key)
        Returns true if this function contains a mapping for the specified key.

        Note that for some kind of functions (e.g., hashes) this method will always return true. In particular, this default implementation always returns true.

        Parameters:
        key - the key.
        Returns:
        true if this function associates a value to key.
        See Also:
        Function.containsKey(Object)
      • containsKey

        @Deprecated
        default boolean containsKey​(Object key)
        Deprecated.
        Please use the corresponding type-specific method instead.
        Returns true if this function contains a mapping for the specified key.

        Note that for some kind of functions (e.g., hashes) this method will always return true. This default implementation, in particular, always return true.

        Specified by:
        containsKey in interface Function<Character,​Boolean>
        Parameters:
        key - the key.
        Returns:
        true if this function associates a value to key.
        See Also:
        Map.containsKey(Object)
      • defaultReturnValue

        default void defaultReturnValue​(boolean rv)
        Sets the default return value (optional operation). This value must be returned by type-specific versions of get(), put() and remove() to denote that the map does not contain the specified key. It must be 0/false/null by default.
        Parameters:
        rv - the new default return value.
        See Also:
        defaultReturnValue()
      • defaultReturnValue

        default boolean defaultReturnValue()
        Gets the default return value.

        This default implementation just return the default null value of the type (null for objects, 0 for scalars, false for Booleans).

        Returns:
        the current default return value.