OptionalFloat (org.macroing.cit.java API)

java.lang.Object
- org.macroing.cit.java.util.OptionalFloat

```
public final class OptionalFloat
extends java.lang.Object
```
A container object which may or may not contain a float value.
If a value is present, isPresent() will return true and getAsFloat() will return the value.
Additional methods that depend on the presence or absence of a contained value are provided, such as orElse(float) (return a default value if value not present) and ifPresent(FloatConsumer) (execute a block of code if the value is present).
This is a value-based class; use of identity-sensitive operations (including reference equality (==), identity hash code, or synchronization) on instances of OptionalFloat may have unpredictable results and should be avoided.

Since:

1.0.0

Author:

Jörgen Lundgren

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static OptionalFloat`	`empty()` Returns an empty `OptionalFloat` instance.
`boolean`	`equals(java.lang.Object object)` Indicates whether some other `Object` is "equal to" this `OptionalFloat`.
`float`	`getAsFloat()` If a value is present in this `OptionalFloat`, returns the value, otherwise throws `NoSuchElementException`.
`int`	`hashCode()` Returns the hash code value of the present value, if any, or `0` (zero) if no value is present.
`void`	`ifPresent(FloatConsumer consumer)` Have the specified `consumer` accept the value if a value is present, otherwise do nothing.
`boolean`	`isPresent()` Returns `true` if there is a value present, otherwise `false`.
`static OptionalFloat`	`of(float value)` Returns an `OptionalFloat` with the specified value present.
`float`	`orElse(float other)` Returns the value if present, otherwise returns `other`.
`float`	`orElseGet(FloatSupplier other)` Returns the value if present, otherwise invokes `other` and returns the result of that invocation.
`<X extends java.lang.Throwable> float`	`orElseThrow(java.util.function.Supplier<X> exceptionSupplier)` Returns the contained value, if present, otherwise throws a `Throwable` to be created by the provided `Supplier`.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - equals
```
public boolean equals(java.lang.Object object)
```
    Indicates whether some other Object is "equal to" this OptionalFloat.
    The other Object is considered equal if:
    - it is also an OptionalFloat and;
    - both instances have no value present or;
    - the present values are "equal to" each other.
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    object - an Object to be tested for equality
    
    Returns:
    
    true if the other Object is "equal to" this OptionalFloat otherwise false
  - isPresent
```
public boolean isPresent()
```
    Returns true if there is a value present, otherwise false.
    
    Returns:
    
    true if there is a value present, otherwise false
  - getAsFloat
```
public float getAsFloat()
```
    If a value is present in this OptionalFloat, returns the value, otherwise throws NoSuchElementException.
    
    Returns:
    
    the value held by this OptionalFloat
    
    Throws:
    
    java.util.NoSuchElementException - if there is no value present
  - orElse
```
public float orElse(float other)
```
    Returns the value if present, otherwise returns other.
    
    Parameters:
    
    other - the value to be returned if there is no value present
    
    Returns:
    
    the value if present, otherwise returns other
  - orElseGet
```
public float orElseGet(FloatSupplier other)
```
    Returns the value if present, otherwise invokes other and returns the result of that invocation.
    
    Parameters:
    
    other - a FloatSupplier whose result is returned if no value is present
    
    Returns:
    
    the value if present, otherwise invokes other and returns the result of that invocation
    
    Throws:
    
    java.lang.NullPointerException - if value is not present and other is null
  - orElseThrow
```
public <X extends java.lang.Throwable> float orElseThrow(java.util.function.Supplier<X> exceptionSupplier)
                                                  throws X extends java.lang.Throwable
```
    Returns the contained value, if present, otherwise throws a Throwable to be created by the provided Supplier.
    
    Type Parameters:
    
    X - the type of the Throwable to be thrown
    
    Parameters:
    
    exceptionSupplier - the Supplier which will return the Throwable to be thrown
    
    Returns:
    
    the contained value, if present
    
    Throws:
    
    java.lang.NullPointerException - if no value is present and exceptionSupplier is null
    
    X - if there is no value present
    
    X extends java.lang.Throwable
  - hashCode
```
public int hashCode()
```
    Returns the hash code value of the present value, if any, or 0 (zero) if no value is present.
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    
    the hash code value of the present value, if any, or 0 (zero) if no value is present
  - ifPresent
```
public void ifPresent(FloatConsumer consumer)
```
    Have the specified consumer accept the value if a value is present, otherwise do nothing.
    
    Parameters:
    
    consumer - block to be executed if a value is present
    
    Throws:
    
    java.lang.NullPointerException - if value is present and consumer is null
  - empty
```
public static OptionalFloat empty()
```
    Returns an empty OptionalFloat instance.
    No value is present for this OptionalFloat.
    
    Returns:
    
    an empty OptionalFloat instance
  - of
```
public static OptionalFloat of(float value)
```
    Returns an OptionalFloat with the specified value present.
    
    Parameters:
    
    value - the value to be present
    
    Returns:
    
    an OptionalFloat with the specified value present

Class OptionalFloat

Method Summary

Methods inherited from class java.lang.Object

Method Detail

equals

isPresent

getAsFloat

orElse

orElseGet

orElseThrow

hashCode

ifPresent

empty

of