net.powermatcher.api.data

Class Price

java.lang.Object

net.powermatcher.api.data.Price

All Implemented Interfaces:

java.lang.Comparable<Price>

public class Price
extends java.lang.Object
implements java.lang.Comparable<Price>

This immutable data object represents a price in the powermatcher cluster.

Field Summary

Fields

Modifier and Type	Field and Description
static java.text.DecimalFormat	PRICE_FORMAT The DecimalFormat used to format the String representation of this instance's priceValue.

Constructor Summary

Constructors

Constructor and Description
Price(MarketBasis marketBasis, double price) A constructor to create an instance of Price.

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(Price that) Compares this object with the specified object for order.
boolean	equals(java.lang.Object obj)
MarketBasis	getMarketBasis()
double	getPriceValue()
int	hashCode()
PriceStep	toPriceStep()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

PRICE_FORMAT

public static final java.text.DecimalFormat PRICE_FORMAT

The DecimalFormat used to format the String representation of this instance's priceValue.

Constructor Detail

Price

public Price(MarketBasis marketBasis,
     double price)

A constructor to create an instance of Price.

Parameters:

marketBasis - the MarketBasis of this Price.

price - the value of this Price.

Method Detail

getMarketBasis

public MarketBasis getMarketBasis()

Returns:

the current value of marketBasis.

getPriceValue

public double getPriceValue()

Returns:

the current value of priceValue.

toPriceStep

public PriceStep toPriceStep()

Returns:

The PriceStep representation of this 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

compareTo

public int compareTo(Price that)

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. This method compares the priceValues of both instances. The one with the highest value is the greatest.

Specified by:

compareTo in interface java.lang.Comparable<Price>

Parameters:

that - The Price instance you want to compare with this one.

Returns:

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Throws:

java.lang.IllegalArgumentException - is the MarketBasis is null.