cyclops.box

Class MutableLong

java.lang.Object

cyclops.box.MutableLong

Type Parameters:

T - Type held inside closed var

All Implemented Interfaces:

To<MutableLong>, java.util.function.LongConsumer, java.util.function.LongSupplier, java.util.function.Supplier<java.lang.Long>

public class MutableLong
extends java.lang.Object
implements To<MutableLong>, java.util.function.LongSupplier, java.util.function.LongConsumer, java.util.function.Supplier<java.lang.Long>

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");
 

Constructor Summary

Constructors

Constructor and Description
MutableLong()

Method Summary

Modifier and Type	Method and Description
void	accept(long value)
static MutableLong	fromExternal(java.util.function.LongSupplier s, java.util.function.LongConsumer c) Construct a MutableLong that gets and sets an external value using the provided Supplier and Consumer e.g.
java.lang.Long	get()
long	getAsLong()
MutableLong	mapInput(java.util.function.LongUnaryOperator fn) Use the supplied function to perform a lazy map operation when get is called
<T1> Mutable<T1>	mapInputToObj(java.util.function.Function<T1,java.lang.Long> fn) Use the supplied function to perform a lazy map operation when get is called
MutableLong	mapOutput(java.util.function.LongUnaryOperator 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.Long,R> fn) Use the supplied function to perform a lazy map operation when get is called
MutableLong	mutate(java.util.function.LongFunction<java.lang.Long> varFn)
static MutableLong	of(long var) Create a Mutable variable, which can be mutated inside a Closure e.g.
MutableLong	set(long var)
java.util.stream.LongStream	toLongStream()
java.util.OptionalLong	toOptionalLong()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.aol.cyclops2.types.To

to

Methods inherited from interface java.util.function.LongConsumer

andThen

Constructor Detail

MutableLong

public MutableLong()

Method Detail

of

public static MutableLong of(long 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 MutableLong fromExternal(java.util.function.LongSupplier s,
                                       java.util.function.LongConsumer c)

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

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

Parameters:

s - Supplier of an external value

c - Consumer that sets an external value

Returns:

MutableLong that gets / sets an external (mutable) value

mapOutputToObj

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

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

  
  MutableLong mutable = MutableLong.fromExternal(()->!this.value,val->!this.value);
  Mutable<Long> withOverride = mutable.mapOutputToObj(b->{ 
                                                        if(override)
                                                             return 10.0;
                                                         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.Long> fn)

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

  
  MutableLong mutable = MutableLong.fromExternal(()->!this.value,val->!this.value);
  Mutable<Long> withOverride = mutable.mapInputToObj(b->{ 
                                                        if(override)
                                                             return 10.0;
                                                         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

mapOutput

public MutableLong mapOutput(java.util.function.LongUnaryOperator fn)

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

  
  MutableLong mutable = MutableLong.fromExternal(()->!this.value,val->!this.value);
  MutableLong withOverride = mutable.mapOutput(b->{ 
                                                        if(override)
                                                             return 10.0;
                                                         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

mapInput

public MutableLong mapInput(java.util.function.LongUnaryOperator fn)

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

  
  MutableLong mutable = MutableLong.fromExternal(()->!this.value,val->!this.value);
  MutableLong withOverride = mutable.mapInput(b->{ 
                                                        if(override)
                                                             return 10.0;
                                                         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

getAsLong

public long getAsLong()

Specified by:

getAsLong in interface java.util.function.LongSupplier

Returns:

Current value

set

public MutableLong set(long var)

Parameters:

var - New value

Returns:

this object with mutated value

mutate

public MutableLong mutate(java.util.function.LongFunction<java.lang.Long> varFn)

Parameters:

varFn - New value

Returns:

this object with mutated value

toOptionalLong

public java.util.OptionalLong toOptionalLong()

toLongStream

public java.util.stream.LongStream toLongStream()

get

public java.lang.Long get()

Specified by:

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

accept

public void accept(long value)

Specified by:

accept in interface java.util.function.LongConsumer