com.caplin.motif.fx.rates

Class Precision

java.lang.Object

com.caplin.motif.fx.rates.Precision

public class Precision
extends Object

An object that encapsulates the information needed by the client to display an FX rate correctly. This includes information such as the total number of decimals and which digits are the pips.

Constructor Summary

Constructors

Constructor and Description
Precision(String numberOfDigitsBeforePips, String numberOfPips) Creates a new Precision object with the specified parameters.
Precision(String numberOfDigitsBeforePips, String numberOfPips, String numberOfFractionalPips) Deprecated. The numberOfFractionalPips is no longer required, use the new constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o) Two instances of Precision are considered equal if they have the same return value for each of these methods:
String	getNumberOfDigitsBeforePips() Returns the number of digits between the decimal point and the first pip digit.
String	getNumberOfFractionalPips() Returns the number of digits there are after the pips.
String	getNumberOfPips() Returns the number of pip digits there are.
int	hashCode() Two instances of Precision have the same hash code if they have the same return value for each of these methods:
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Precision

@Deprecated
public Precision(String numberOfDigitsBeforePips,
                             String numberOfPips,
                             String numberOfFractionalPips)

Deprecated. The numberOfFractionalPips is no longer required, use the new constructor.

Creates a new Precision object with the specified parameters.

Parameters:

numberOfDigitsBeforePips - The number of digits between the decimal point and first pip digit. For example, on a USDGBP rate of 1.23456 where the "45" are the pips, this value should be "2". There are two digits between the decimal point and the "4".

numberOfPips - The number of pip digits there are. This is almost always "2".

numberOfFractionalPips - The number of digits there are after the pips. For example, on a USDGBP rate of 1.23456 where the "45" are the pips, this value should be "1" because there is one digit after the "5".

Precision

public Precision(String numberOfDigitsBeforePips,
                 String numberOfPips)

Creates a new Precision object with the specified parameters.

Parameters:

numberOfDigitsBeforePips - The number of digits between the decimal point and first pip digit. For example, on a USDGBP rate of 1.23456 where the "45" are the pips, this value should be "2". There are two digits between the decimal point and the "4".

numberOfPips - The number of pip digits there are. This is almost always "2".

Method Detail

getNumberOfDigitsBeforePips

public String getNumberOfDigitsBeforePips()

Returns the number of digits between the decimal point and the first pip digit.

Returns:

The number of digits between the decimal point and first pip digit. For example, on a USDGBP rate of 1.23456 where the "45" are the pips, this value should be "2". There are two digits between the decimal point and the "4".

getNumberOfPips

public String getNumberOfPips()

Returns the number of pip digits there are. This value is almost always "2".

Returns:

The number of pip digits.

getNumberOfFractionalPips

public String getNumberOfFractionalPips()

Returns the number of digits there are after the pips.

Returns:

The number of digits there are after the pips. For example, on a USDGBP rate of 1.23456 where the "45" are the pips, this value should be "1" because there is one digit after the "5".

equals

public boolean equals(Object o)

Two instances of Precision are considered equal if they have the same return value for each of these methods:

• getNumberOfDigitsBeforePips()
• getNumberOfPips()
• getNumberOfFractionalPips()

Overrides:

equals in class Object

hashCode

public int hashCode()

Two instances of Precision have the same hash code if they have the same return value for each of these methods:

• getNumberOfDigitsBeforePips()
• getNumberOfPips()
• getNumberOfFractionalPips()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object