Interface Long2BooleanFunction
-
- All Known Subinterfaces:
Long2BooleanMap
,Long2BooleanSortedMap
- All Known Implementing Classes:
AbstractLong2BooleanFunction
,AbstractLong2BooleanMap
,AbstractLong2BooleanSortedMap
,Long2BooleanArrayMap
,Long2BooleanAVLTreeMap
,Long2BooleanFunctions.EmptyFunction
,Long2BooleanFunctions.PrimitiveFunction
,Long2BooleanFunctions.Singleton
,Long2BooleanFunctions.SynchronizedFunction
,Long2BooleanFunctions.UnmodifiableFunction
,Long2BooleanLinkedOpenHashMap
,Long2BooleanMaps.EmptyMap
,Long2BooleanMaps.Singleton
,Long2BooleanMaps.SynchronizedMap
,Long2BooleanMaps.UnmodifiableMap
,Long2BooleanOpenCustomHashMap
,Long2BooleanOpenHashMap
,Long2BooleanRBTreeMap
,Long2BooleanSortedMaps.EmptySortedMap
,Long2BooleanSortedMaps.Singleton
,Long2BooleanSortedMaps.SynchronizedSortedMap
,Long2BooleanSortedMaps.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 Long2BooleanFunction extends Function<Long,Boolean>, LongPredicate
A type-specificFunction
; provides some additional methods that use polymorphism to avoid (un)boxing.Type-specific versions of
get()
,put()
andremove()
cannot rely onnull
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 thedefaultReturnValue()
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-specificcontainsKey()
, 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()
andremove()
for maps with primitive-type keys or values returnnull
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 notnull
.- See Also:
Function
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods Modifier and Type Method Description default boolean
containsKey(long 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(long 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(long key, boolean value)
Adds a pair to the map (optional operation).default Boolean
put(Long key, Boolean value)
Deprecated.Please use the corresponding type-specific method instead.default boolean
remove(long 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(long operand)
-
Methods inherited from interface java.util.function.LongPredicate
and, negate, or
-
-
-
-
Method Detail
-
test
default boolean test(long operand)
- Specified by:
test
in interfaceLongPredicate
- Since:
- 8.0.0
-
put
default boolean put(long 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(long 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(long 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(Long 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 interfaceFunction<Long,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 interfaceFunction<Long,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 interfaceFunction<Long,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(long 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 interfaceFunction<Long,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 ofget()
,put()
andremove()
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.
-
-