LazyBoolean (Commons 1.1.0-SNAPSHOT API)

java.lang.Object
- org.atlanmod.commons.LazyBoolean

```
@ParametersAreNonnullByDefault
public final class LazyBoolean
extends Object
```
An object that automatically loads a boolean by using a BooleanSupplier during the first call to getAsBoolean().

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`getAsBoolean()`	Gets the wrapped value.
`boolean`	`isLoaded()`	Returns `true` if the value has been loaded.
`static LazyBoolean`	`of(boolean value)`	Creates a new lazy boolean with the embed value.
`void`	`unload()`	Unloads the wrapped value.
`void`	`update(boolean newValue)`	Updates the wrapped value.
`static LazyBoolean`	`with(BooleanSupplier loadFunction)`	Creates a new lazy boolean with the `BooleanSupplier` to load the embed value.

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

- Method Detail
  - of
```
@Nonnull
public static LazyBoolean of(boolean value)
```
    Creates a new lazy boolean with the embed value.
    
    Parameters:
    
    value - the embed value
    
    Returns:
    
    a new lazy object
  - with
```
@Nonnull
public static LazyBoolean with(BooleanSupplier loadFunction)
```
    Creates a new lazy boolean with the BooleanSupplier to load the embed value.
    
    Parameters:
    
    loadFunction - the function used to load the value
    
    Returns:
    
    a new lazy boolean
  - getAsBoolean
```
public boolean getAsBoolean()
```
    Gets the wrapped value. On the first call, the object is created.
    
    Returns:
    
    the value
  - update
```
public void update(boolean newValue)
```
    Updates the wrapped value.
    
    Parameters:
    
    newValue - the new value
  - isLoaded
```
public boolean isLoaded()
```
    Returns true if the value has been loaded.
    
    Returns:
    
    true if the value has been loaded
  - unload
```
public void unload()
```
    Unloads the wrapped value. If the value is not loaded, then this method does nothing.