org.flexiblepower.efi.util

Class FillLevelFunction.Builder<T>

java.lang.Object

org.flexiblepower.efi.util.FillLevelFunction.Builder<T>

Type Parameters:

T - The type of the value that is stored at each element

Enclosing class:

FillLevelFunction<T>

public static class FillLevelFunction.Builder<T>
extends java.lang.Object

This helper class should be used to easily define a FillLevelFunction. See the FillLevelFunction.create(double) method to get a new instance of this class.

Method Summary

Methods

Modifier and Type	Method and Description
FillLevelFunction.Builder<T>	add(double upperBound, T value) Adds a new element to the FillLevelFunction that we are creating.
FillLevelFunction<T>	build()

Methods inherited from class java.lang.Object

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

Method Detail

add

public FillLevelFunction.Builder<T> add(double upperBound,
                               T value)

Adds a new element to the FillLevelFunction that we are creating. It will use the upperBound of the last element (or the lowerBound that we started with if it does not exist) as the lowerBound for the new element.

Parameters:

upperBound - The upperBound of the new element. This must always be larger than the lowerBound.

value - The value that is to be associated with this element

Returns:

This FillLevelFunction.Builder

build

public FillLevelFunction<T> build()

Returns:

A new immutable FillLevelFunction object that contains all the elements that have been added until now.