com.aol.cyclops.closures.mutable

Class MutableChar

java.lang.Object

com.aol.cyclops.closures.mutable.MutableChar

Type Parameters:

T - Type held inside closed var

All Implemented Interfaces:

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

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

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.

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

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MutableChar.CharFunction

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

Convertable.SupplierToConvertable<T>

Constructor Summary

Constructors

Constructor and Description
MutableChar()

Method Summary

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

MutableChar

public MutableChar()

Method Detail

of

public static <T> MutableChar of(char var)

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

   MutableChar char = MutableChar.of('c');
   
    char.mutate(n->'d'))
   
   System.out.println(num.getAsChar());
   //prints d
  

Parameters:

var - Initial value of Mutable

Returns:

New Mutable instance

fromExternal

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

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

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

Parameters:

s - Supplier of an external value

c - Consumer that sets an external value

Returns:

MutableChar that gets / sets an external (mutable) value

mapOutputToObj

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

Use the supplied function to perform a lazy map operation when get is called

  
  MutableChar mutable = MutableChar.fromExternal(()->!this.value,val->!this.value);
  Mutable<Character> withOverride = mutable.mapOutput(b->{ 
                                                        if(override)
                                                             return 'a';
                                                         return b;
                                                         });
          
 
 

Parameters:

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

Returns:

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

mapInputToObj

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

Use the supplied function to perform a lazy map operation when get is called

  
  MutableChar mutable = MutableChar.fromExternal(()->!this.value,val->!this.value);
  Mutable<Character> withOverride = mutable.mapInput(b->{ 
                                                        if(override)
                                                             return 'v';
                                                         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

getAsChar

public char getAsChar()

Returns:

Current value

set

public MutableChar set(char var)

Parameters:

var - New value

Returns:

this object with mutated value

mutate

public MutableChar mutate(MutableChar.CharFunction varFn)

Parameters:

varFn - New value

Returns:

this object with mutated value

accept

public void accept(java.lang.Character t)

Specified by:

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

get

public java.lang.Character get()

Specified by:

get in interface Convertable<java.lang.Character>

Specified by:

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

Returns:

Contained value, maybe null