Package it.unimi.dsi.fastutil.bytes

Interface Byte2BooleanFunction

All Superinterfaces:
it.unimi.dsi.fastutil.Function<java.lang.Byte,​java.lang.Boolean>, java.util.function.Function<java.lang.Byte,​java.lang.Boolean>, java.util.function.IntPredicate
All Known Subinterfaces:
Byte2BooleanMap, Byte2BooleanSortedMap
All Known Implementing Classes:
AbstractByte2BooleanFunction, AbstractByte2BooleanMap, AbstractByte2BooleanSortedMap, Byte2BooleanArrayMap, Byte2BooleanAVLTreeMap, Byte2BooleanFunctions.EmptyFunction, Byte2BooleanFunctions.PrimitiveFunction, Byte2BooleanFunctions.Singleton, Byte2BooleanFunctions.SynchronizedFunction, Byte2BooleanFunctions.UnmodifiableFunction, Byte2BooleanLinkedOpenHashMap, Byte2BooleanMaps.EmptyMap, Byte2BooleanMaps.Singleton, Byte2BooleanMaps.SynchronizedMap, Byte2BooleanMaps.UnmodifiableMap, Byte2BooleanOpenCustomHashMap, Byte2BooleanOpenHashMap, Byte2BooleanRBTreeMap, Byte2BooleanSortedMaps.EmptySortedMap, Byte2BooleanSortedMaps.Singleton, Byte2BooleanSortedMaps.SynchronizedSortedMap, Byte2BooleanSortedMaps.UnmodifiableSortedMap
Functional Interface:
This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
@FunctionalInterface
public interface Byte2BooleanFunction
extends it.unimi.dsi.fastutil.Function<java.lang.Byte,​java.lang.Boolean>, java.util.function.IntPredicate
A type-specific Function; provides some additional methods that use polymorphism to avoid (un)boxing.

Type-specific versions of get(), put() and remove() cannot rely on null to denote absence of a key. Rather, they return a default return value, which is set to 0/false at creation, but can be changed using the defaultReturnValue() method.

For uniformity reasons, even functions returning objects implement the default return value (of course, in this case the default return value is initialized to null).

The default implementation of optional operations just throw an UnsupportedOperationException, except for the type-specific containsKey(), which return true. Generic versions of accessors delegate to the corresponding type-specific counterparts following the interface rules.

Warning: to fall in line as much as possible with the standard map interface, it is required that standard versions of get(), put() and remove() for maps with primitive-type keys or values return null to denote missing keys rather than wrap the default return value in an object. In case both keys and values are reference types, the default return value must be returned instead, thus violating the standard map interface when the default return value is not null.

See Also:
Function

  • Method Summary

    Modifier and Type Method Description
    default <T> java.util.function.Function<java.lang.Byte,​T> andThen​(java.util.function.Function<? super java.lang.Boolean,​? extends T> after)
    Deprecated.
    Please use the corresponding type-specific method instead.
    default it.unimi.dsi.fastutil.bytes.Byte2ByteFunction andThenByte​(Boolean2ByteFunction after)  
    default it.unimi.dsi.fastutil.bytes.Byte2CharFunction andThenChar​(Boolean2CharFunction after)  
    default it.unimi.dsi.fastutil.bytes.Byte2DoubleFunction andThenDouble​(Boolean2DoubleFunction after)  
    default it.unimi.dsi.fastutil.bytes.Byte2FloatFunction andThenFloat​(Boolean2FloatFunction after)  
    default it.unimi.dsi.fastutil.bytes.Byte2IntFunction andThenInt​(Boolean2IntFunction after)  
    default it.unimi.dsi.fastutil.bytes.Byte2LongFunction andThenLong​(Boolean2LongFunction after)  
    default <T> it.unimi.dsi.fastutil.bytes.Byte2ObjectFunction<T> andThenObject​(Boolean2ObjectFunction<? extends T> after)  
    default <T> it.unimi.dsi.fastutil.bytes.Byte2ReferenceFunction<T> andThenReference​(Boolean2ReferenceFunction<? extends T> after)  
    default it.unimi.dsi.fastutil.bytes.Byte2ShortFunction andThenShort​(Boolean2ShortFunction after)  
    default <T> java.util.function.Function<T,​java.lang.Boolean> compose​(java.util.function.Function<? super T,​? extends java.lang.Byte> before)
    Deprecated.
    Please use the corresponding type-specific method instead.
    default Byte2BooleanFunction composeByte​(it.unimi.dsi.fastutil.bytes.Byte2ByteFunction before)  
    default Char2BooleanFunction composeChar​(it.unimi.dsi.fastutil.chars.Char2ByteFunction before)  
    default Double2BooleanFunction composeDouble​(it.unimi.dsi.fastutil.doubles.Double2ByteFunction before)  
    default Float2BooleanFunction composeFloat​(it.unimi.dsi.fastutil.floats.Float2ByteFunction before)  
    default Int2BooleanFunction composeInt​(it.unimi.dsi.fastutil.ints.Int2ByteFunction before)  
    default Long2BooleanFunction composeLong​(it.unimi.dsi.fastutil.longs.Long2ByteFunction before)  
    default <T> Object2BooleanFunction<T> composeObject​(it.unimi.dsi.fastutil.objects.Object2ByteFunction<? super T> before)  
    default <T> Reference2BooleanFunction<T> composeReference​(it.unimi.dsi.fastutil.objects.Reference2ByteFunction<? super T> before)  
    default Short2BooleanFunction composeShort​(it.unimi.dsi.fastutil.shorts.Short2ByteFunction before)  
    default boolean containsKey​(byte key)
    Returns true if this function contains a mapping for the specified key.
    default boolean containsKey​(java.lang.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​(byte key)
    Returns the value to which the given key is mapped.
    default java.lang.Boolean get​(java.lang.Object key)
    Deprecated.
    Please use the corresponding type-specific method instead.
    default boolean getOrDefault​(byte key, boolean defaultValue)
    Returns the value associated by this function to the specified key, or give the specified value if not present.
    default java.lang.Boolean getOrDefault​(java.lang.Object key, java.lang.Boolean defaultValue)
    Deprecated.
    Please use the corresponding type-specific method instead.
    default boolean put​(byte key, boolean value)
    Adds a pair to the map (optional operation).
    default java.lang.Boolean put​(java.lang.Byte key, java.lang.Boolean value)
    Deprecated.
    Please use the corresponding type-specific method instead.
    default boolean remove​(byte key)
    Removes the mapping with the given key (optional operation).
    default java.lang.Boolean remove​(java.lang.Object key)
    Deprecated.
    Please use the corresponding type-specific method instead.
    default boolean test​(int operand)
    Deprecated.
    Please use primitive types which do not have to be widened as keys.

    Methods inherited from interface it.unimi.dsi.fastutil.Function

    apply, clear, size

    Methods inherited from interface java.util.function.IntPredicate

    and, negate, or

  • Method Details

    • test

      @Deprecated default boolean test​(int operand)
      Deprecated.
      Please use primitive types which do not have to be widened as keys.
      Specified by:
      test in interface java.util.function.IntPredicate
      Throws:
      java.lang.IllegalArgumentException - If the given operand is not an element of the key domain.
      Since:
      8.0.0
      Implementation Specification:
      This default implementation delegates to the type-specific get() method after narrowing down the key to the actual key type, throwing an exception if the given key cannot be represented in the restricted domain. This is done for interoperability with the Java 8 function environment. The use of this method is discouraged, as unexpected errors can occur. Instead, the corresponding classes should be used (e.g., Int2IntFunction instead of Short2IntFunction).

    • put

      default boolean put​(byte 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​(byte 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)

    • getOrDefault

      default boolean getOrDefault​(byte key, boolean defaultValue)
      Returns the value associated by this function to the specified key, or give the specified value if not present.
      Parameters:
      key - the key.
      defaultValue - the value to return if not present.
      Returns:
      the corresponding value, or defaultValue if no value was present for the given key.
      Since:
      8.5.0
      See Also:
      Function.getOrDefault(Object, Object)

    • remove

      default boolean remove​(byte 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 java.lang.Boolean put​(java.lang.Byte key, java.lang.Boolean value)
      Deprecated.
      Please use the corresponding type-specific method instead.
      Specified by:
      put in interface it.unimi.dsi.fastutil.Function<java.lang.Byte,​java.lang.Boolean>

    • get

      @Deprecated default java.lang.Boolean get​(java.lang.Object key)
      Deprecated.
      Please use the corresponding type-specific method instead.
      Specified by:
      get in interface it.unimi.dsi.fastutil.Function<java.lang.Byte,​java.lang.Boolean>

    • getOrDefault

      @Deprecated default java.lang.Boolean getOrDefault​(java.lang.Object key, java.lang.Boolean defaultValue)
      Deprecated.
      Please use the corresponding type-specific method instead.
      Specified by:
      getOrDefault in interface it.unimi.dsi.fastutil.Function<java.lang.Byte,​java.lang.Boolean>

    • remove

      @Deprecated default java.lang.Boolean remove​(java.lang.Object key)
      Deprecated.
      Please use the corresponding type-specific method instead.
      Specified by:
      remove in interface it.unimi.dsi.fastutil.Function<java.lang.Byte,​java.lang.Boolean>

    • containsKey

      default boolean containsKey​(byte 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​(java.lang.Object key)
      Deprecated.
      Please use the corresponding type-specific method instead.
      Specified by:
      containsKey in interface it.unimi.dsi.fastutil.Function<java.lang.Byte,​java.lang.Boolean>

    • 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.

    • compose

      @Deprecated default <T> java.util.function.Function<T,​java.lang.Boolean> compose​(java.util.function.Function<? super T,​? extends java.lang.Byte> before)
      Deprecated.
      Please use the corresponding type-specific method instead.
      Specified by:
      compose in interface java.util.function.Function<java.lang.Byte,​java.lang.Boolean>

    • andThen

      @Deprecated default <T> java.util.function.Function<java.lang.Byte,​T> andThen​(java.util.function.Function<? super java.lang.Boolean,​? extends T> after)
      Deprecated.
      Please use the corresponding type-specific method instead.
      Specified by:
      andThen in interface java.util.function.Function<java.lang.Byte,​java.lang.Boolean>

    • andThenByte

      default it.unimi.dsi.fastutil.bytes.Byte2ByteFunction andThenByte​(Boolean2ByteFunction after)

    • composeByte

      default Byte2BooleanFunction composeByte​(it.unimi.dsi.fastutil.bytes.Byte2ByteFunction before)

    • andThenShort

      default it.unimi.dsi.fastutil.bytes.Byte2ShortFunction andThenShort​(Boolean2ShortFunction after)

    • composeShort

      default Short2BooleanFunction composeShort​(it.unimi.dsi.fastutil.shorts.Short2ByteFunction before)

    • andThenInt

      default it.unimi.dsi.fastutil.bytes.Byte2IntFunction andThenInt​(Boolean2IntFunction after)

    • composeInt

      default Int2BooleanFunction composeInt​(it.unimi.dsi.fastutil.ints.Int2ByteFunction before)

    • andThenLong

      default it.unimi.dsi.fastutil.bytes.Byte2LongFunction andThenLong​(Boolean2LongFunction after)

    • composeLong

      default Long2BooleanFunction composeLong​(it.unimi.dsi.fastutil.longs.Long2ByteFunction before)

    • andThenChar

      default it.unimi.dsi.fastutil.bytes.Byte2CharFunction andThenChar​(Boolean2CharFunction after)

    • composeChar

      default Char2BooleanFunction composeChar​(it.unimi.dsi.fastutil.chars.Char2ByteFunction before)

    • andThenFloat

      default it.unimi.dsi.fastutil.bytes.Byte2FloatFunction andThenFloat​(Boolean2FloatFunction after)

    • composeFloat

      default Float2BooleanFunction composeFloat​(it.unimi.dsi.fastutil.floats.Float2ByteFunction before)

    • andThenDouble

      default it.unimi.dsi.fastutil.bytes.Byte2DoubleFunction andThenDouble​(Boolean2DoubleFunction after)

    • composeDouble

      default Double2BooleanFunction composeDouble​(it.unimi.dsi.fastutil.doubles.Double2ByteFunction before)

    • andThenObject

      default <T> it.unimi.dsi.fastutil.bytes.Byte2ObjectFunction<T> andThenObject​(Boolean2ObjectFunction<? extends T> after)

    • composeObject

      default <T> Object2BooleanFunction<T> composeObject​(it.unimi.dsi.fastutil.objects.Object2ByteFunction<? super T> before)

    • andThenReference

      default <T> it.unimi.dsi.fastutil.bytes.Byte2ReferenceFunction<T> andThenReference​(Boolean2ReferenceFunction<? extends T> after)

    • composeReference

      default <T> Reference2BooleanFunction<T> composeReference​(it.unimi.dsi.fastutil.objects.Reference2ByteFunction<? super T> before)