org.bladerunnerjs.api.memoization

Class MemoizedValue<T>

java.lang.Object

org.bladerunnerjs.api.memoization.MemoizedValue<T>

Type Parameters:

T - the type of value to be memoized

public class MemoizedValue<T>
extends java.lang.Object

Provides Memoization by using the FileModificationRegistry to check whether or not files have changed and values need to be recomputed.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	RECALCULATING_VALUE_MSG
static java.lang.String	USING_MEMOIZED_VALUE_MSG

Constructor Summary

Constructors

Constructor and Description
MemoizedValue(java.lang.String valueIdentifier, org.bladerunnerjs.model.engine.Node node)
MemoizedValue(java.lang.String valueIdentifier, org.bladerunnerjs.model.engine.RootNode rootNode, java.io.File... watchItems)
MemoizedValue(java.lang.String valueIdentifier, org.bladerunnerjs.model.engine.RootNode rootNode, java.util.List<java.io.File> watchItems)

Method Summary

Modifier and Type	Method and Description
<E extends java.lang.Exception> T	value(Getter<E> getter) Used to access the Memoized value.

Methods inherited from class java.lang.Object

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

Field Detail

RECALCULATING_VALUE_MSG

public static final java.lang.String RECALCULATING_VALUE_MSG

See Also:

Constant Field Values

USING_MEMOIZED_VALUE_MSG

public static final java.lang.String USING_MEMOIZED_VALUE_MSG

See Also:

Constant Field Values

Constructor Detail

MemoizedValue

public MemoizedValue(java.lang.String valueIdentifier,
                     org.bladerunnerjs.model.engine.Node node)

MemoizedValue

public MemoizedValue(java.lang.String valueIdentifier,
                     org.bladerunnerjs.model.engine.RootNode rootNode,
                     java.io.File... watchItems)

MemoizedValue

public MemoizedValue(java.lang.String valueIdentifier,
                     org.bladerunnerjs.model.engine.RootNode rootNode,
                     java.util.List<java.io.File> watchItems)

Method Detail

value

public <E extends java.lang.Exception> T value(Getter<E> getter)
                                        throws E extends java.lang.Exception

Used to access the Memoized value. If the value needs to be computed the Getter is executed to calculate the new value. Lambas can provided instead of a getter, for example:

 
 memoizedValue.value(() -> {
   return SomethingThatTakesALongTimeToComplete();
 });
 
 

Be aware that using Lambdas is only supported in Java8.

Type Parameters:

E - the type of exception

Parameters:

getter - The getter used to calculate the value

Returns:

The calculated value

Throws:

E - for any exception

E extends java.lang.Exception