Caplin Systems - FormattedRate (FX Integration API Documentation)

java.lang.Object
- com.caplin.motif.fx.config.FormattedRate

public class FormattedRate
extends java.lang.Object

Constructor Summary

Constructors
Constructor Description

FormattedRate(java.math.BigDecimal rate, int digitsBeforePips, int numberOfPips, int dps)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(java.lang.Object o)`
`int`	`getDigitsBeforePips()`
`int`	`getDps()`
`int`	`getNumberOfPips()`
`java.math.BigDecimal`	`getRate()`
`int`	`hashCode()`
`java.lang.String`	`toString()`

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

- Constructor Detail
  - FormattedRate
```
public FormattedRate(@Nonnull
                     java.math.BigDecimal rate,
                     int digitsBeforePips,
                     int numberOfPips,
                     int dps)
```
    Parameters:
    
    rate - The rate, e.g. 1.12345
    
    digitsBeforePips - The number of digits between the decimal character and the pips, e.g. 2
    
    numberOfPips - The number of pips digits, e.g. 2
    
    dps - The number of decimal places of the rate, e.g. 5
- Method Detail
  - getRate
```
@Nonnull
public java.math.BigDecimal getRate()
```
  - getDigitsBeforePips
```
public int getDigitsBeforePips()
```
  - getNumberOfPips
```
public int getNumberOfPips()
```
  - getDps
```
public int getDps()
```
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object