com.oath.cyclops.util.box

Class MutableBoolean

java.lang.Object

com.oath.cyclops.util.box.MutableBoolean

Type Parameters:

T - Type held inside closed var

All Implemented Interfaces:

To<MutableBoolean>, java.util.function.BooleanSupplier, java.util.function.Consumer<java.lang.Boolean>, java.util.function.Supplier<java.lang.Boolean>

public class MutableBoolean
extends java.lang.Object
implements To<MutableBoolean>, java.util.function.BooleanSupplier, java.util.function.Consumer<java.lang.Boolean>, java.util.function.Supplier<java.lang.Boolean>

Class that represents a Closed Variable In Java 8 because of the effectively final rule references to captured variables can't be changed. e.g.

 boolean var = true;
 Runnable r = () -> var =false;
 

Won't compile because var is treated as if it is final. This can be 'worked around' by using a wrapping object or array. e.g.

 MutableBoolean var =  MutableBoolean.of(true);
 Runnable r = () -> var.set(false);
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MutableBoolean.BooleanFunction

Constructor Summary

Constructors

Constructor and Description
MutableBoolean()

Method Summary

Modifier and Type	Method and Description
void	accept(java.lang.Boolean t)
static MutableBoolean	fromExternal(java.util.function.BooleanSupplier s, java.util.function.Consumer<java.lang.Boolean> c) Construct a MutableBoolean that gets and sets an external value using the provided Supplier and Consumer e.g.
java.lang.Boolean	get()
boolean	getAsBoolean()
<T1> Mutable<T1>	mapInputToObj(java.util.function.Function<T1,java.lang.Boolean> fn) Use the supplied function to perform a lazy transform operation when getValue is called
<R> Mutable<R>	mapOutputToObj(java.util.function.Function<java.lang.Boolean,R> fn) Use the supplied function to perform a lazy transform operation when getValue is called
MutableBoolean	mutate(MutableBoolean.BooleanFunction varFn)
static <T> MutableBoolean	of(boolean var) Create a Mutable variable, which can be mutated inside a Closure e.g.
MutableBoolean	set(boolean var)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.oath.cyclops.types.foldable.To

to

Methods inherited from interface java.util.function.Consumer

andThen

Constructor Detail

MutableBoolean

public MutableBoolean()

Method Detail

of

public static <T> MutableBoolean of(boolean var)

Create a Mutable variable, which can be mutated inside a Closure e.g.

   MutableBoolean num = MutableBoolean.of(true);

    num.mutate(n->!n))

   System.out.println(num.getAsBoolean());
   //prints false
  

Parameters:

var - Initial value of Mutable

Returns:

New Mutable instance

fromExternal

public static MutableBoolean fromExternal(java.util.function.BooleanSupplier s,
                                          java.util.function.Consumer<java.lang.Boolean> c)

Construct a MutableBoolean that gets and sets an external value using the provided Supplier and Consumer e.g.

 
    MutableBoolean mutable = MutableBoolean.fromExternal(()->!this.value,val->!this.value);
 
 

Parameters:

s - Supplier of an external value

c - Consumer that sets an external value

Returns:

MutableBoolean that gets / sets an external (mutable) value

mapOutputToObj

public <R> Mutable<R> mapOutputToObj(java.util.function.Function<java.lang.Boolean,R> fn)

Use the supplied function to perform a lazy transform operation when getValue is called

 
  MutableBoolean mutable = MutableBoolean.fromExternal(()->!this.value,val->!this.value);
  Mutable<Boolean> withOverride = mutable.mapOutput(b->{
                                                        if(override)
                                                             return true;
                                                         return b;
                                                         });

 
 

Parameters:

fn - Map function to be applied to the result when getValue is called

Returns:

Mutable that lazily applies the provided function when getValue is called to the return value

mapInputToObj

public <T1> Mutable<T1> mapInputToObj(java.util.function.Function<T1,java.lang.Boolean> fn)

Use the supplied function to perform a lazy transform operation when getValue is called

 
  MutableBoolean mutable = MutableBoolean.fromExternal(()->!this.value,val->!this.value);
  Mutable<Boolean> withOverride = mutable.mapInput(b->{
                                                        if(override)
                                                             return true;
                                                         return b;
                                                         });

 
 

Parameters:

fn - Map function to be applied to the input when set is called

Returns:

Mutable that lazily applies the provided function when set is called to the input value

getAsBoolean

public boolean getAsBoolean()

Specified by:

getAsBoolean in interface java.util.function.BooleanSupplier

Returns:

Current value

set

public MutableBoolean set(boolean var)

Parameters:

var - New value

Returns:

this object with mutated value

mutate

public MutableBoolean mutate(MutableBoolean.BooleanFunction varFn)

Parameters:

varFn - New value

Returns:

this object with mutated value

accept

public void accept(java.lang.Boolean t)

Specified by:

accept in interface java.util.function.Consumer<java.lang.Boolean>

get

public java.lang.Boolean get()

Specified by:

get in interface java.util.function.Supplier<java.lang.Boolean>