DefaultExchangeRate (Moneta (JSR 354 RI) 0.9-SNAPSHOT API)

java.lang.Object
- org.javamoney.moneta.DefaultExchangeRate

All Implemented Interfaces:

Serializable, Comparable<javax.money.convert.ExchangeRate>, javax.money.convert.ExchangeRate
```
public class DefaultExchangeRate
extends Object
implements javax.money.convert.ExchangeRate, Serializable, Comparable<javax.money.convert.ExchangeRate>
```
This class models an exchange rate, which defines the factor the numeric value of a base amount in some currency 'A' must be multiplied to get the corresponding amount in the terminating currency 'B'. Hereby
- an exchange rate always models one rate from a base (source) to a term (target) CurrencyUnit.
- an exchange rate is always bound to a rate type, which typically matches the data source of the conversion data, e.g. different credit card providers may use different rates for the same conversion.
- an exchange rate may restrict its validity. In most of the use cases a rates' validity will be well defined, but it is also possible that the data provider is not able to support the rate's validity, leaving it undefined-
- an exchange rate has a provider, which is responsible for defining the rate. A provider hereby may be, but must not be the same as the rate's data source.
- an exchange rate can be a direct rate, where its factor is represented by a single conversion step. Or it can model a derived rate, where multiple conversion steps are required to define the overall base/term conversion. In case of derived rates the chained rates define the overall factor, by multiplying the individual chain rate factors. Of course, this also requires that each subsequent rate's base currency in the chain does match the previous term currency (and vice versa):
- Whereas the factor should be directly implied by the internal rate chain for derived rates, this is obviously not the case for the validity range, since rates can have a undefined validity range. Nevertheless in many cases also the validity range can (but must not) be derived from the rate chain.
- Finally a conversion rate is always unidirectional. There might be cases where the reciprocal value of factor matches the correct reverse rate. But in most use cases the reverse rate either has a different rate (not equal to the reciprocal value), or might not be defined at all. Therefore for reversing a ExchangeRate one must access an ExchangeRateProvider and query for the reverse rate.
The class also implements Comparable to allow sorting of multiple exchange rates using the following sorting order;
- Exchange rate type
- Exchange rate provider
- base currency
- term currency
Finally ExchangeRate is modeled as an immutable and thread safe type. Also exchange rates are Serializable, hereby serializing in the following form and order:
- The base CurrencyUnit
- The target CurrencyUnit
- The factor (NumberValue)
- The ConversionContext
- The rate chain
Author:

Werner Keil, Anatole Tresch

See Also:

Wikipedia: Exchange Rate (Quotations), Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class DefaultExchangeRate.Builder
Builder for creating new instances of ExchangeRate.

Nested Classes
Modifier and Type	Class and Description
`static class`	`DefaultExchangeRate.Builder` Builder for creating new instances of `ExchangeRate`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(javax.money.convert.ExchangeRate o)`
`boolean`	`equals(Object obj)`
`javax.money.CurrencyUnit`	`getBase()` Get the base (source) `CurrencyUnit`.
`javax.money.convert.ConversionContext`	`getConversionContext()` Access the `ConversionContext` of `ExchangeRate`.
`List<javax.money.convert.ExchangeRate>`	`getExchangeRateChain()` Access the chain of exchange rates.
`javax.money.NumberValue`	`getFactor()` Access the rate's bid factor.
`javax.money.CurrencyUnit`	`getTerm()` Get the term (target) `CurrencyUnit`.
`int`	`hashCode()`
`boolean`	`isDerived()` Allows to evaluate if this exchange rate is a derived exchange rate.
`DefaultExchangeRate.Builder`	`toBuilder()` Create a `DefaultExchangeRate.Builder` based on the current rate instance.
`String`	`toString()`

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

- Method Detail
  - getConversionContext
```
public final javax.money.convert.ConversionContext getConversionContext()
```
    Access the ConversionContext of ExchangeRate.
    
    Specified by:
    
    getConversionContext in interface javax.money.convert.ExchangeRate
    
    Returns:
    
    the conversion context, never null.
  - getBase
```
public final javax.money.CurrencyUnit getBase()
```
    Get the base (source) CurrencyUnit.
    
    Specified by:
    
    getBase in interface javax.money.convert.ExchangeRate
    
    Returns:
    
    the base CurrencyUnit.
  - getTerm
```
public final javax.money.CurrencyUnit getTerm()
```
    Get the term (target) CurrencyUnit.
    
    Specified by:
    
    getTerm in interface javax.money.convert.ExchangeRate
    
    Returns:
    
    the term CurrencyUnit.
  - getFactor
```
public final javax.money.NumberValue getFactor()
```
    Access the rate's bid factor.
    
    Specified by:
    
    getFactor in interface javax.money.convert.ExchangeRate
    
    Returns:
    
    the bid factor for this exchange rate, or null.
  - getExchangeRateChain
```
public final List<javax.money.convert.ExchangeRate> getExchangeRateChain()
```
    Access the chain of exchange rates.
    
    Specified by:
    
    getExchangeRateChain in interface javax.money.convert.ExchangeRate
    
    Returns:
    
    the chain of rates, in case of a derived rate, this may be several instances. For a direct exchange rate, this equals to new ExchangeRate[]{this}.
  - isDerived
```
public final boolean isDerived()
```
    Allows to evaluate if this exchange rate is a derived exchange rate.
    Derived exchange rates are defined by an ordered list of subconversions with intermediate steps, whereas a direct conversion is possible in one steps.
    This method always returns true, if the chain contains more than one rate. Direct rates, have also a chain, but with exact one rate.
    
    Specified by:
    
    isDerived in interface javax.money.convert.ExchangeRate
    
    Returns:
    
    true, if the exchange rate is derived.
  - compareTo
```
public int compareTo(javax.money.convert.ExchangeRate o)
```
    Specified by:
    
    compareTo in interface Comparable<javax.money.convert.ExchangeRate>
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toBuilder
```
public DefaultExchangeRate.Builder toBuilder()
```
    Create a DefaultExchangeRate.Builder based on the current rate instance.
    
    Returns:
    
    a new DefaultExchangeRate.Builder, never null.

Class DefaultExchangeRate

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getConversionContext

getBase

getTerm

getFactor

getExchangeRateChain

isDerived

compareTo

toString

hashCode

equals

toBuilder