net.powermatcher.api.data

Class ArrayBid.Builder

java.lang.Object

net.powermatcher.api.data.ArrayBid.Builder

Enclosing class:

ArrayBid

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

A builder class to create an ArrayBid instance.

Constructor Summary

Constructors

Constructor and Description
ArrayBid.Builder(MarketBasis marketBasis) Constructor to create an instance of this class.

Method Summary

Methods

Modifier and Type	Method and Description
ArrayBid	build() Makes sure the whole array is filled, then creates the ArrayBid with the Builder's internal values.
ArrayBid.Builder	demand(double demand) Adds a demand double to builderDemand.
ArrayBid.Builder	demandArray(double... demand) Sets the demandArray with the supplied demand array.
ArrayBid.Builder	fillTo(int priceStep) fills the demand array from the nextIndex until the designated priceStep with the last set demand Will do nothing on an already filled array.

Methods inherited from class java.lang.Object

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

Constructor Detail

ArrayBid.Builder

public ArrayBid.Builder(MarketBasis marketBasis)

Constructor to create an instance of this class.

Parameters:

marketBasis - the MarketBasis of the cluster.

Method Detail

demand

public ArrayBid.Builder demand(double demand)

Adds a demand double to builderDemand.

Parameters:

demand - The demand to be added to the demand array. Must not be higher than the previous added demand.

Returns:

this instance of the Builder, with the added demand

Throws:

java.lang.IllegalArgumentException - when the demand to be added is higher than the demand already in the array

java.lang.ArrayIndexOutOfBoundsException - when the demand array is already full

demandArray

public ArrayBid.Builder demandArray(double... demand)

Sets the demandArray with the supplied demand array. The supplied array must not be ascending. The length of the array should be the same size as the number of price steps in the marketBasis.

Parameters:

demand - The new demand array

Returns:

this instance of the Builder, with the added array

Throws:

java.lang.IllegalArgumentException - if the size of the array differs from the number of priceSteps in the MarketBasis or if the demand array is ascending

build

public ArrayBid build()

Makes sure the whole array is filled, then creates the ArrayBid with the Builder's internal values.

Returns:

The created ArrayBid

Throws:

java.lang.IllegalArgumentException - When the length of the demandArray is not equal to the number of price steps

fillTo

public ArrayBid.Builder fillTo(int priceStep)

fills the demand array from the nextIndex until the designated priceStep with the last set demand Will do nothing on an already filled array.

Parameters:

priceStep - The priceStep to fill to.

Returns:

this instance of the Builder, with the filled demand array

Throws:

java.lang.IllegalStateException - when nextIndex is zero (no demand has been set, yet)

java.lang.IllegalArgumentException - when the supplied priceStep is higher than the number of price steps in the marketBasis