net.sf.mpxj

Class Rate

java.lang.Object

net.sf.mpxj.Rate

public final class Rate
extends Object

This class represents a currency rate per period of time (for example $10/h) as found in an MPX file.

Field Summary

Fields

Modifier and Type	Field and Description
static Rate	ZERO

Constructor Summary

Constructors

Constructor and Description
Rate(double amount, TimeUnit time) This constructor builds an instance of this class from a currency amount and a time unit.
Rate(Number amount, TimeUnit time) This constructor builds an instance of this class from a currency amount and a time unit.

Method Summary

Modifier and Type	Method and Description
boolean	amountComponentEquals(Rate rhs) Equality test for amount component of a Rate instance.
boolean	equals(Object obj)
static boolean	equals(Rate rate1, Rate rate2) Compare two rates handling null values.
double	getAmount() Accessor method to retrieve the currency amount.
TimeUnit	getUnits() Accessor method to retrieve the time units.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

ZERO

public static final Rate ZERO

Constructor Detail

Rate

public Rate(Number amount,
            TimeUnit time)

This constructor builds an instance of this class from a currency amount and a time unit.

Parameters:

amount - currency amount

time - time units

Rate

public Rate(double amount,
            TimeUnit time)

This constructor builds an instance of this class from a currency amount and a time unit.

Parameters:

amount - currency amount

time - time units

Method Detail

getAmount

public double getAmount()

Accessor method to retrieve the currency amount.

Returns:

amount component of the rate

getUnits

public TimeUnit getUnits()

Accessor method to retrieve the time units.

Returns:

time component of the rate

equals

public static boolean equals(Rate rate1,
                             Rate rate2)

Compare two rates handling null values.

Parameters:

rate1 - rate to compare

rate2 - rate ro compare

Returns:

true if rates are equal/equivalent

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

amountComponentEquals

public boolean amountComponentEquals(Rate rhs)

Equality test for amount component of a Rate instance. Note that this does not take into account the units - use with care!

Parameters:

rhs - rate to compare

Returns:

true if amount components are equal, within the allowable delta

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object