net.powermatcher.api.data

Class PriceStep

java.lang.Object

net.powermatcher.api.data.PriceStep

public class PriceStep
extends java.lang.Object

This immutable data object represents a priceStep and its MarketBasis. A priceStep is the index in the demand array. This is an integer and can be any value between 0 and marketbasis.priceSteps. The value 0 corresponds to the minimal price and marketbasis.priceStep - 1 corresponds to the the maximal price.

Constructor Summary

Constructors

Constructor and Description
PriceStep(MarketBasis marketBasis, int priceStep) A constructor that creates a new PricePoint instance.

Method Summary

Methods

Modifier and Type	Method and Description
PriceStep	decrement()
boolean	equals(java.lang.Object obj)
MarketBasis	getMarketBasis()
int	getPriceStep()
int	hashCode()
PriceStep	increment()
boolean	isMaximum()
boolean	isMinimum()
Price	toPrice() Creates a Price, based on the MarketBasis as the priceStep.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

PriceStep

public PriceStep(MarketBasis marketBasis,
         int priceStep)

A constructor that creates a new PricePoint instance.

Parameters:

marketBasis - the marketbasis of this cluster.

priceStep - the value of the priceStep.

Method Detail

getMarketBasis

public MarketBasis getMarketBasis()

Returns:

the current value of marketBasis.

getPriceStep

public int getPriceStep()

Returns:

the current value of priceStep.

isMaximum

public boolean isMaximum()

Returns:

true when the PriceStep is at its maximum (e.g. marketBasis.getPriceSteps() - 1)

isMinimum

public boolean isMinimum()

Returns:

true when the PriceStep is at its minimum (e.g. 0)

increment

public PriceStep increment()

Returns:

The PriceStep that is exactly 1 step above the current.

Throws:

java.lang.IllegalStateException - when it is already at its maximum level.

decrement

public PriceStep decrement()

Returns:

The PriceStep that is exactly 1 step below the current.

Throws:

java.lang.IllegalStateException - when it is already at its minimum level.

toPrice

public Price toPrice()

Creates a Price, based on the MarketBasis as the priceStep.

Returns:

the new Price

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object