com.oath.cyclops.util.box

Class MutableFloat

java.lang.Object

com.oath.cyclops.util.box.MutableFloat

Type Parameters:

T - Type held inside closed var

All Implemented Interfaces:

To<MutableFloat>, java.util.function.Consumer<java.lang.Float>, java.util.function.Supplier<java.lang.Float>

public class MutableFloat
extends java.lang.Object
implements To<MutableFloat>, java.util.function.Supplier<java.lang.Float>, java.util.function.Consumer<java.lang.Float>

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.

 float 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.

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MutableFloat.FloatFunction

Constructor Summary

Constructors

Constructor and Description
MutableFloat()

Method Summary

Modifier and Type	Method and Description
void	accept(java.lang.Float t)
static MutableFloat	fromExternal(java.util.function.Supplier<java.lang.Float> s, java.util.function.Consumer<java.lang.Float> c) Construct a MutableFloat that gets and sets an external value using the provided Supplier and Consumer e.g.
java.lang.Float	get()
float	getAsFloat()
<T1> Mutable<T1>	mapInputToObj(java.util.function.Function<T1,java.lang.Float> 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.Float,R> fn) Use the supplied function to perform a lazy transform operation when getValue is called
MutableFloat	mutate(MutableFloat.FloatFunction varFn)
static <T> MutableFloat	of(float var) Create a Mutable variable, which can be mutated inside a Closure e.g.
MutableFloat	set(float 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

MutableFloat

public MutableFloat()

Method Detail

of

public static <T> MutableFloat of(float var)

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

   MutableFloat num = MutableFloat.of(true);

    num.mutate(n->!n))

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

Parameters:

var - Initial value of Mutable

Returns:

New Mutable instance

fromExternal

public static MutableFloat fromExternal(java.util.function.Supplier<java.lang.Float> s,
                                        java.util.function.Consumer<java.lang.Float> c)

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

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

Parameters:

s - Supplier of an external value

c - Consumer that sets an external value

Returns:

MutableFloat that gets / sets an external (mutable) value

mapOutputToObj

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

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

 
  MutableFloat mutable = MutableFlaot.fromExternal(()->!this.value,val->!this.value);
  Mutable<Float> withOverride = mutable.mapOutputToObj(b->{
                                                        if(override)
                                                             return 1f;
                                                         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.Float> fn)

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

 
  MutableFloat mutable = MutableBoolean.fromExternal(()->!this.value,val->!this.value);
  Mutable<Float> withOverride = mutable.mapInputToObj(b->{
                                                        if(override)
                                                             return 2f;
                                                         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

getAsFloat

public float getAsFloat()

Returns:

Current value

set

public MutableFloat set(float var)

Parameters:

var - New value

Returns:

this object with mutated value

mutate

public MutableFloat mutate(MutableFloat.FloatFunction varFn)

Parameters:

varFn - New value

Returns:

this object with mutated value

get

public java.lang.Float get()

Specified by:

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

accept

public void accept(java.lang.Float t)

Specified by:

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