org.flexiblepower.ral.values

Class CommodityForecast.Builder

java.lang.Object

org.flexiblepower.ral.values.CommodityForecast.Builder

Enclosing class:

CommodityForecast

public static final class CommodityForecast.Builder
extends java.lang.Object

The Builder object that will be used to easily create CommodityForecasts.

Method Summary

Methods

Modifier and Type	Method and Description
CommodityForecast.Builder	add(CommodityUncertainMeasurables commodityMeasurable)
CommodityForecast.Builder	add(Profile.Element<CommodityUncertainMeasurables> element)
CommodityForecast	build()
CommodityForecast.Builder	duration(javax.measure.Measurable<javax.measure.quantity.Duration> duration) Set the duration and saves it for future creation of elements.
CommodityForecast.Builder	electricity(UncertainMeasure<javax.measure.quantity.Power> value) Set the electricity value and saves it for future creation of elements.
CommodityForecast.Builder	gas(UncertainMeasure<javax.measure.quantity.VolumetricFlowRate> value) Set the gas value and saves it for future creation of elements.
CommodityForecast.Builder	heat(UncertainMeasure<javax.measure.quantity.Power> value) Set the heat value and saves it for future creation of elements.
CommodityForecast.Builder	next() Uses the values as set by the duration(Measurable), electricity(UncertainMeasure), gas(UncertainMeasure) and heat(UncertainMeasure) methods to create a new element.

Methods inherited from class java.lang.Object

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

Method Detail

duration

public CommodityForecast.Builder duration(javax.measure.Measurable<javax.measure.quantity.Duration> duration)

Set the duration and saves it for future creation of elements.

Parameters:

duration - The duration for the element

Returns:

This builder

See Also:

next()

electricity

public CommodityForecast.Builder electricity(UncertainMeasure<javax.measure.quantity.Power> value)

Set the electricity value and saves it for future creation of elements.

Parameters:

value - The electricity value for the element

Returns:

This builder

See Also:

next()

gas

public CommodityForecast.Builder gas(UncertainMeasure<javax.measure.quantity.VolumetricFlowRate> value)

Set the gas value and saves it for future creation of elements.

Parameters:

value - The gas value for the element

Returns:

This builder

See Also:

next()

heat

public CommodityForecast.Builder heat(UncertainMeasure<javax.measure.quantity.Power> value)

Set the heat value and saves it for future creation of elements.

Parameters:

value - The heat value for the element

Returns:

This builder

See Also:

next()

next

public CommodityForecast.Builder next()

Uses the values as set by the duration(Measurable), electricity(UncertainMeasure), gas(UncertainMeasure) and heat(UncertainMeasure) methods to create a new element. This does not reset the values, so if you call this method again it will create a second element that is equal to the first.

Returns:

This builder

Throws:

java.lang.IllegalArgumentException - when the duration has not been set using duration(Measurable)

add

public CommodityForecast.Builder add(Profile.Element<CommodityUncertainMeasurables> element)

Parameters:

element - The element that needs to be added.

Returns:

This builder

add

public CommodityForecast.Builder add(CommodityUncertainMeasurables commodityMeasurable)

Parameters:

commodityMeasurable - The CommodityMeasurables that will be used (together with the set duration) to add a new element.

Returns:

This builder

Throws:

java.lang.IllegalArgumentException - when the duration has not been set using duration(Measurable)

build

public CommodityForecast build()