com.agi.moxie.api

Class AbstractScriptedDiscreteValueBuilder<T,R>

java.lang.Object

com.agi.moxie.api.AbstractScriptedDiscreteValueBuilder<T,R>

Type Parameters:

T - The underlying type of the signal

R - The resulting signal type that will be built by this builder

Direct Known Subclasses:

ScriptedDiscreteValue.Builder

public abstract class AbstractScriptedDiscreteValueBuilder<T,R>
extends Object

A helper base class to facilitate building scripted data values.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractScriptedDiscreteValueBuilder() Creates a signal builder with no initial value.
protected	AbstractScriptedDiscreteValueBuilder(T initialValue) Creates a signal builder with an initial value at MoxieTime.getMinValue().

Method Summary

Modifier and Type	Method and Description
AbstractScriptedDiscreteValueBuilder<T,R>	add(MoxieTime momentOfChange, T newValue) Add a change to the script.
R	build() Builds a final result from the collected script.
protected abstract R	buildFinalResult(NavigableMap<MoxieTime,T> script) Overridden by subclasses to build the final result value.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractScriptedDiscreteValueBuilder

protected AbstractScriptedDiscreteValueBuilder()

Creates a signal builder with no initial value.

AbstractScriptedDiscreteValueBuilder

protected AbstractScriptedDiscreteValueBuilder(T initialValue)

Creates a signal builder with an initial value at MoxieTime.getMinValue().

Parameters:

initialValue - The initial value.

Method Detail

buildFinalResult

protected abstract R buildFinalResult(NavigableMap<MoxieTime,T> script)

Overridden by subclasses to build the final result value.

Parameters:

script - The script of values and their change times.

Returns:

The result value.

build

public final R build()

Builds a final result from the collected script. This invalidates this builder and causes subsequent operations to throw.

Returns:

The result value.

add

public final AbstractScriptedDiscreteValueBuilder<T,R> add(@NotNull
                                                           MoxieTime momentOfChange,
                                                           T newValue)

Add a change to the script.

Parameters:

momentOfChange - The moment of the change.

newValue - The new value at momentOfChange.

Returns:

The builder.