com.aol.cyclops.closures.mutable

Class Mutable<T>

java.lang.Object

com.aol.cyclops.closures.mutable.Mutable<T>

Type Parameters:

T - Type held inside closed var

All Implemented Interfaces:

Convertable<T>, java.lang.Iterable<T>, java.util.function.Consumer<T>, java.util.function.Supplier<T>

public class Mutable<T>
extends java.lang.Object
implements java.util.function.Supplier<T>, java.util.function.Consumer<T>, Convertable<T>

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.

 
 String var = "hello";
 Runnable r = () -> var ="world";
 

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.

 Mutable<String> var =  Mutable.of("hello");
 Runnable r = () -> var.set("world");
 

Nested Class Summary

Nested classes/interfaces inherited from interface com.aol.cyclops.closures.Convertable

Convertable.SupplierToConvertable<T>

Constructor Summary

Constructors

Constructor and Description
Mutable()

Method Summary

Modifier and Type	Method and Description
void	accept(T t)
static <T> Mutable<T>	fromExternal(java.util.function.Supplier<T> s, java.util.function.Consumer<T> c) Construct a Mutable that gets and sets an external value using the provided Supplier and Consumer e.g.
T	get()
<T1> Mutable<T1>	mapInput(java.util.function.Function<T1,T> fn)
<R> Mutable<R>	mapOutput(java.util.function.Function<T,R> fn)
Mutable<T>	mutate(java.util.function.Function<T,T> varFn)
static <T> Mutable<T>	of(T var) Create a Mutable variable, which can be mutated inside a Closure e.g.
Mutable<T>	set(T var)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Consumer

andThen

Methods inherited from interface com.aol.cyclops.closures.Convertable

fromSupplier, iterator, orElse, orElseGet, orElseThrow, toAtomicReference, toCompletableFuture, toCompletableFutureAsync, toCompletableFutureAsync, toList, toOptional, toOptionalAtomicReference, toStream, when, when, whenOrElse

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

Mutable

public Mutable()

Method Detail

of

public static <T> Mutable<T> of(T var)

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

   Mutable<Integer> num = Mutable.of(20);
   
   Stream.of(1,2,3,4).map(i->i*10).peek(i-> num.mutate(n->n+i)).foreach(System.out::println);
   
   System.out.println(num.get());
   //prints 120
  

Parameters:

var - Initial value of Mutable

Returns:

New Mutable instance

fromExternal

public static <T> Mutable<T> fromExternal(java.util.function.Supplier<T> s,
                                          java.util.function.Consumer<T> c)

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

  
    Mutable<Integer> mutable = Mutable.from(()->this.value*2,val->this.value=val);
 
 

Parameters:

s - Supplier of an external value

c - Consumer that sets an external value

Returns:

Mutable that gets / sets an external (mutable) value

mapOutput

public <R> Mutable<R> mapOutput(java.util.function.Function<T,R> fn)

mapInput

public <T1> Mutable<T1> mapInput(java.util.function.Function<T1,T> fn)

get

public T get()

Specified by:

get in interface Convertable<T>

Specified by:

get in interface java.util.function.Supplier<T>

Returns:

Current value

set

public Mutable<T> set(T var)

Parameters:

var - New value

Returns:

this object with mutated value

mutate

public Mutable<T> mutate(java.util.function.Function<T,T> varFn)

Parameters:

varFn - New value

Returns:

this object with mutated value

accept

public void accept(T t)

Specified by:

accept in interface java.util.function.Consumer<T>