Package net.apartium.cocoabeans.utils
Class OptionalFloat
java.lang.Object
net.apartium.cocoabeans.utils.OptionalFloat
A java optional like wrapper class for float primitive type
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionstatic OptionalFloatempty()Retrieves a global empty OptionalFloat instancebooleanfilter(FloatPredicate predicate) Filters given instance.floatRetrieves current value as float, or throws an exception if emptyfloatgetOrThrow(Supplier<RuntimeException> exceptionSupplier) Retrieves current value, or throws given exception if nulinthashCode()voidifPresent(FloatConsumer consumer) Executes given consumer if current instance is not emptybooleanisEmpty()Checks whether current instance is empty.boolean<E> Optional<E>mapToObj(FloatToObject<E> operation) Maps current value to an object.static OptionalFloatof(float val) Creates a new OptionalFloat instance consisting of given valuefloatorElse(float f) Returns current value, or given value if emptyfloatorElseGet(FloatSupplier supplier) Attempts to return current value, but if this instance is empty retrieves value from given suppliertoString()
-
Method Details
-
empty
Retrieves a global empty OptionalFloat instance- Returns:
- a global empty OptionalFloat instance
- See Also:
-
of
Creates a new OptionalFloat instance consisting of given value- Parameters:
val- value- Returns:
- a new OptionalFloat instance
-
isEmpty
public boolean isEmpty()Checks whether current instance is empty.- Returns:
- true if empty, otherwise false
-
getAsFloat
public float getAsFloat()Retrieves current value as float, or throws an exception if empty- Returns:
- current float value
-
ifPresent
Executes given consumer if current instance is not empty- Parameters:
consumer- given consumer action
-
getOrThrow
Retrieves current value, or throws given exception if nul- Parameters:
exceptionSupplier- exception supplier- Returns:
- float value
- Throws:
RuntimeException- exceptionSupplier if empty
-
filter
Filters given instance. Given predicate will not invoke if current instance is empty- Parameters:
predicate- if given predicate returns true, return the current instance, if false returns empty instance- Returns:
- See Also:
-
mapToObj
Maps current value to an object. If empty, will return empty optional instance.- Type Parameters:
E- object element type- Parameters:
operation- mapping operation- Returns:
- mapped value
-
orElse
public float orElse(float f) Returns current value, or given value if empty- Parameters:
f- value to return if current value is empty- Returns:
- current value, or given value if empty
-
orElseGet
Attempts to return current value, but if this instance is empty retrieves value from given supplier- Parameters:
supplier- supplier to be used if current instance is empty- Returns:
- float value
-
isPresent
public boolean isPresent()- Returns:
- true if current instance is not empty, else false
-
equals
-
hashCode
public int hashCode() -
toString
-