ExchangeRate (Joda money 0.7-SNAPSHOT API)

java.lang.Object
- org.joda.money.ExchangeRate

All Implemented Interfaces:

Serializable
```
public final class ExchangeRate
extends Object
implements Serializable
```
Represents an exchange rate that allows BigMoneyProvider instances to be converted between amounts in different CurrencyUnits. Exchange rate is an object that holds data about two CurrencyUnits and a conversion rate, and basically mirrors the following equation:
1 major unit of target currency = rate major units of source currency.
Exchange rates provide a few simple operations that can be performed with them through ExchangeRateOperations . A default implementation can be acquired using operations(int, RoundingMode).
Instances of this class are immutable.

Two instances of this class are considered equal when both target and source currencies are the same and the rates compare equal according to BigDecimal.compareTo(BigDecimal).
Please be aware that creating an exchange rate less or equal to 0 is considered an error.

Author:

Tom Pasierb

See Also:
Serialized Form

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`BigDecimal`	`getRate()` Returns the conversion rate.
`CurrencyUnit`	`getSource()` Returns the source currency.
`CurrencyUnit`	`getTarget()` Returns the target currency.
`int`	`hashCode()`
`static ExchangeRate`	`identity(CurrencyUnit currency)` Creates an identity rate for the given `CurrencyUnit`.
`static ExchangeRate`	`of(BigDecimal rate, CurrencyUnit source, CurrencyUnit target)` Creates an Exchange rate with the given parameters.
`ExchangeRateOperations`	`operations()` Creates an instance of an object that knows how to perform operations on `ExchangeRate`s with default values for `scale` and `roundingMode` that will be used for calculations.
`ExchangeRateOperations`	`operations(int scale, RoundingMode roundingMode)` Creates an instance of an object that knows how to perform operations on `ExchangeRate`s.
`static ExchangeRate`	`parse(String exchangeRate)`
`String`	`toString()`
`ExchangeRate`	`withRate(BigDecimal rate)` Creates an ExchangeRate like this one with the given rate.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - parse
```
public static ExchangeRate parse(String exchangeRate)
```
  - identity
```
public static ExchangeRate identity(CurrencyUnit currency)
```
    Creates an identity rate for the given CurrencyUnit. The rate will be equal to 1.00 and both source and target currency units will be the same as the given one.
    
    Parameters:
    currency - to be set for source and target currency units.
    
    Returns:
    identity exchange rate having rate 1 and the same source and target currencies
    
    Throws:
    
    NullPointerException - if the given parameter is null
  - of
```
public static ExchangeRate of(BigDecimal rate,
              CurrencyUnit source,
              CurrencyUnit target)
```
    Creates an Exchange rate with the given parameters.
    
    Parameters:
    rate - the conversion rate
    source - source CurrencyUnit
    target - target CurrencyUnit
    
    Returns:
    an instance of exchange rate parameterized as instructed
    
    Throws:
    
    NullPointerException - if any of the given parameters is null
    
    IllegalArgumentException - if the given rate is less or equal to 0 or when source and currency units are equal and rate is not equal to 1
  - withRate
```
public ExchangeRate withRate(BigDecimal rate)
```
    Creates an ExchangeRate like this one with the given rate.
    
    Parameters:
    rate - the rate that the new ExchangeRate should have
    
    Returns:
    a copy of this with the given rate and all other settings as this one
    See Also:
    of(BigDecimal, CurrencyUnit, CurrencyUnit)
  - getRate
```
public BigDecimal getRate()
```
    Returns the conversion rate.
    
    Returns:
    the conversion rate between this exchange rate's source and target currencies
  - getSource
```
public CurrencyUnit getSource()
```
    Returns the source currency.
    
    Returns:
    the source currency
  - getTarget
```
public CurrencyUnit getTarget()
```
    Returns the target currency.
    
    Returns:
    the target currency
  - operations
```
public ExchangeRateOperations operations(int scale,
                                RoundingMode roundingMode)
```
    Creates an instance of an object that knows how to perform operations on ExchangeRates.
    
    Parameters:
    scale - scale that will be used for calculations
    roundingMode - rounding mode to use if rounding is necessary
    
    Returns:
    an instance of ExchangeRateOperations
  - operations
```
public ExchangeRateOperations operations()
```
    Creates an instance of an object that knows how to perform operations on ExchangeRates with default values for scale and roundingMode that will be used for calculations. The values used as defaults are:
    - scale = 16
    - roundingMode = RoundingMode.HALF_EVEN
    Returns:
    an instance of ExchangeRateOperations
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class ExchangeRate

Method Summary

Methods inherited from class java.lang.Object

Method Detail

parse

identity

of

withRate

getRate

getSource

getTarget

operations

operations

hashCode

equals

toString