org.flexiblepower.ral.values

Class ConstraintListMap

java.lang.Object

org.flexiblepower.ral.values.CommodityMap<ConstraintList<?>>

org.flexiblepower.ral.values.ConstraintListMap

All Implemented Interfaces:

java.util.Map<Commodity<?,?>,ConstraintList<?>>

public final class ConstraintListMap
extends CommodityMap<ConstraintList<?>>

The ConstraintListMap is used to store a ConstraintList for each Commodity.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConstraintListMap.Builder This helper class makes it easy to create an instance of the ConstraintListMap.

Field Summary

Fields

Modifier and Type	Field and Description
static ConstraintListMap	EMPTY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ConstraintListMap(ConstraintList<javax.measure.quantity.Power> electricityValue, ConstraintList<javax.measure.quantity.VolumetricFlowRate> gasValue, ConstraintList<javax.measure.quantity.Power> heatValue)

Method Summary

Methods

Modifier and Type	Method and Description
static ConstraintListMap.Builder	create()
static ConstraintListMap	electricity(ConstraintList<javax.measure.quantity.Power> electricityValue)
static ConstraintListMap	gas(ConstraintList<javax.measure.quantity.VolumetricFlowRate> gasValue)
<BQ extends javax.measure.quantity.Quantity,FQ extends javax.measure.quantity.Quantity> ConstraintList<FQ>	get(Commodity<BQ,FQ> commodity)
static ConstraintListMap	heat(ConstraintList<javax.measure.quantity.Power> heatValue)

Methods inherited from class org.flexiblepower.ral.values.CommodityMap

clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, toString, values

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY

public static final ConstraintListMap EMPTY

Constructor Detail

ConstraintListMap

protected ConstraintListMap(ConstraintList<javax.measure.quantity.Power> electricityValue,
                 ConstraintList<javax.measure.quantity.VolumetricFlowRate> gasValue,
                 ConstraintList<javax.measure.quantity.Power> heatValue)

Method Detail

create

public static ConstraintListMap.Builder create()

Returns:

A new ConstraintListMap.Builder object that can be used to create the ConstraintListMap more easily.

electricity

public static ConstraintListMap electricity(ConstraintList<javax.measure.quantity.Power> electricityValue)

Parameters:

electricityValue - The ConstraintList of the electricity

Returns:

A ConstraintListMap which only contains a value for Commodity.ELECTRICITY

gas

public static ConstraintListMap gas(ConstraintList<javax.measure.quantity.VolumetricFlowRate> gasValue)

Parameters:

gasValue - The ConstraintList of the gas

Returns:

A ConstraintListMap which only contains a value for Commodity.GAS

heat

public static ConstraintListMap heat(ConstraintList<javax.measure.quantity.Power> heatValue)

Parameters:

heatValue - The ConstraintList of the heat

Returns:

A ConstraintListMap which only contains a value for Commodity.HEAT

get

public <BQ extends javax.measure.quantity.Quantity,FQ extends javax.measure.quantity.Quantity> ConstraintList<FQ> get(Commodity<BQ,FQ> commodity)