net.powermatcher.core.bidcache

Class AggregatedBid.Builder

java.lang.Object

net.powermatcher.core.bidcache.AggregatedBid.Builder

Enclosing class:

AggregatedBid

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

A Builder that makes it easier to create an AggregatedBid. The idea is that you can call the addAgentBid(String, BidUpdate) or addBid(Bid) several times to define the AggregatedBid . When calling the build() method it returns the created aggregated bid and this AggregatedBid.Builder should not be used after that. Example usage:

 AggregateBid bid = new AggregatedBid.Builder(marketBasis).addAgentBid("agent1", bid1)
                                                          .addAgentBid("agent2", bid2)
                                                          .build();
 

This class is not thread-safe.

Constructor Summary

Constructors

Constructor and Description
AggregatedBid.Builder(MarketBasis marketBasis) Creates a new AggregatedBid.Builder that should be used to generate a new AggregatedBid.

Method Summary

Methods

Modifier and Type	Method and Description
AggregatedBid.Builder	addAgentBid(java.lang.String agentId, BidUpdate bidUpdate) Adds the bid of an agent.
AggregatedBid.Builder	addBid(Bid bid)
AggregatedBid	build()

Methods inherited from class java.lang.Object

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

Constructor Detail

AggregatedBid.Builder

public AggregatedBid.Builder(MarketBasis marketBasis)

Creates a new AggregatedBid.Builder that should be used to generate a new AggregatedBid.

Parameters:

marketBasis - The MarketBasis that is used to base the new AggregatedBid on.

Method Detail

addAgentBid

public AggregatedBid.Builder addAgentBid(java.lang.String agentId,
                                BidUpdate bidUpdate)

Adds the bid of an agent. This saves the bid internally for later use and adds the bid on the sum of all the other bids. Warning: when this method is called multiple times with the same agentId or the marketBasis does not match the marketBasis of the bid, the call is ignored.

Parameters:

agentId - The unqiue identifier of the agent that has sent the bid.

bidUpdate - The bidUpdate that has to be added to the aggregated bid.

Returns:

This AggregatedBid.Builder

addBid

public AggregatedBid.Builder addBid(Bid bid)

build

public AggregatedBid build()

Returns:

The new AggregatedBid object that contains all the added bids. After this method has been called, the AggregatedBid.Builder should not be used any further.