org.flexiblepower.efi.util

Class FillLevelFunction<T>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<FillLevelFunction.RangeElement<T>>

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

Type Parameters:

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

All Implemented Interfaces:

java.lang.Iterable<FillLevelFunction.RangeElement<T>>, java.util.Collection<FillLevelFunction.RangeElement<T>>, java.util.List<FillLevelFunction.RangeElement<T>>

public class FillLevelFunction<T>
extends java.util.AbstractList<FillLevelFunction.RangeElement<T>>

This class approximates a function where the value is dependent on the fill level of the buffer. It implements a List of FillLevelFunction.RangeElements and can be used in that manner.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FillLevelFunction.Builder<T> This helper class should be used to easily define a FillLevelFunction.
static class	FillLevelFunction.RangeElement<T> This class stores the values for each range.

Field Summary

Fields

Modifier and Type	Field and Description
protected FillLevelFunction.RangeElement<T>[]	elements

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
FillLevelFunction(java.util.List<FillLevelFunction.RangeElement<T>> elements)

Method Summary

Methods

Modifier and Type	Method and Description
static <T> FillLevelFunction.Builder<T>	create(double lowerBound)
boolean	equals(java.lang.Object obj)
FillLevelFunction.RangeElement<T>	get(int index)
double	getLowerBound()
FillLevelFunction.RangeElement<T>	getRangeElementForFillLevel(double fillLevel)
double	getUpperBound()
T	getValueForFillLevel(double fillLevel)
int	hashCode()
boolean	isAboveMaximum(double fillLevel)
boolean	isBelowMinimum(double fillLevel)
boolean	isOutsideOfRange(double fillLevel)
int	size()
java.lang.String	toString()

Methods inherited from class java.util.AbstractList

add, add, addAll, clear, indexOf, iterator, lastIndexOf, listIterator, listIterator, remove, removeRange, set, subList

Methods inherited from class java.util.AbstractCollection

addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray

Field Detail

elements

protected final FillLevelFunction.RangeElement<T>[] elements

Constructor Detail

FillLevelFunction

public FillLevelFunction(java.util.List<FillLevelFunction.RangeElement<T>> elements)

Method Detail

create

public static <T> FillLevelFunction.Builder<T> create(double lowerBound)

Parameters:

lowerBound - The lowest bound

Returns:

a new FillLevelFunction.Builder object that can be used to easily create the FillLevelFunction

get

public FillLevelFunction.RangeElement<T> get(int index)

Specified by:

get in interface java.util.List<FillLevelFunction.RangeElement<T>>

Specified by:

get in class java.util.AbstractList<FillLevelFunction.RangeElement<T>>

size

public int size()

Specified by:

size in interface java.util.Collection<FillLevelFunction.RangeElement<T>>

Specified by:

size in interface java.util.List<FillLevelFunction.RangeElement<T>>

Specified by:

size in class java.util.AbstractCollection<FillLevelFunction.RangeElement<T>>

getLowerBound

public double getLowerBound()

Returns:

the lower bound for which this function is valid

getUpperBound

public double getUpperBound()

Returns:

the upper bound for which this function is valid

getValueForFillLevel

public T getValueForFillLevel(double fillLevel)

Parameters:

fillLevel - The fill level of the buffer for which to get the corresponding value

Returns:

the value that corresponds to the fill level

Throws:

java.lang.IllegalArgumentException - when the fillLevel is outside the bounds (see getLowerBound() and getUpperBound())

getRangeElementForFillLevel

public FillLevelFunction.RangeElement<T> getRangeElementForFillLevel(double fillLevel)

Parameters:

fillLevel - The fill level of the buffer for which to get the corresponding element

Returns:

the element that corresponds to the fill level

Throws:

java.lang.IllegalArgumentException - when the fillLevel is outside the bounds (see getLowerBound() and getUpperBound())

isOutsideOfRange

public boolean isOutsideOfRange(double fillLevel)

Parameters:

fillLevel - the value to check.

Returns:

Whether the fill level is outside the total range of this FillLevelFunction.

isBelowMinimum

public boolean isBelowMinimum(double fillLevel)

Parameters:

fillLevel - the value to check.

Returns:

Whether the fill level is lower than the lower bound of this FillLevelFunction.

isAboveMaximum

public boolean isAboveMaximum(double fillLevel)

Parameters:

fillLevel - the value to check.

Returns:

Whether the fill level is higher than the upper bound of this FillLevelFunction.

hashCode

public int hashCode()

Specified by:

hashCode in interface java.util.Collection<FillLevelFunction.RangeElement<T>>

Specified by:

hashCode in interface java.util.List<FillLevelFunction.RangeElement<T>>

Overrides:

hashCode in class java.util.AbstractList<FillLevelFunction.RangeElement<T>>

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface java.util.Collection<FillLevelFunction.RangeElement<T>>

Specified by:

equals in interface java.util.List<FillLevelFunction.RangeElement<T>>

Overrides:

equals in class java.util.AbstractList<FillLevelFunction.RangeElement<T>>

toString

public java.lang.String toString()

Overrides:

toString in class java.util.AbstractCollection<FillLevelFunction.RangeElement<T>>