com.caplin.motif.fx.rates

Class MetalSubjectInfo

java.lang.Object

com.caplin.motif.fx.rates.AbstractSubjectInfo

com.caplin.motif.fx.rates.MetalSubjectInfo

All Implemented Interfaces:

SubjectInfo

public class MetalSubjectInfo
extends AbstractSubjectInfo

A domain object representing a subscription to streaming rates for precious metals, such as XAUUSD.

You do not need to construct instances of this class yourself. They are generated from incoming requests by the MetalSubjectParser and passed to your implementation of CachedDataProvider.onRequest(SubjectInfo).

Constructor Summary

Constructors

Constructor and Description
MetalSubjectInfo(String subject, String baseCurrency, String termCurrency, String unit, String tenor, String amount, String marginBand) Creates an instance of MetalSubjectInfo with the default subject prefix "PM" and the provided parameters.
MetalSubjectInfo(String subject, String subjectPrefix, String baseCurrency, String termCurrency, String unit, String tenor, String amount, String marginBand) Creates an instance of MetalSubjectInfo with a specified subject prefix and the provided parameters .

Method Summary

Modifier and Type	Method and Description
String	getUnit() A proxy method that calls the underlying method AbstractSubjectInfo.getAmountIn().
boolean	isMetal() Returns true.

Methods inherited from class com.caplin.motif.fx.rates.AbstractSubjectInfo

equals, getAmount, getAmountIn, getBaseCurrency, getBrokenDate, getCurrencyPair, getMarginBand, getSubject, getSubjectPrefix, getTenor, getTermCurrency, hashCode, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

MetalSubjectInfo

public MetalSubjectInfo(String subject,
                        String baseCurrency,
                        String termCurrency,
                        String unit,
                        String tenor,
                        String amount,
                        String marginBand)

Creates an instance of MetalSubjectInfo with the default subject prefix "PM" and the provided parameters.

Parameters:

subject - The full subject.

baseCurrency - The first currency in the pair. This is usually the currency code for the metal, such as XAU or XAG.

termCurrency - The second currency in the pair. This is usually the currency, such as USD.

unit - The unit that the amount is specified in such, as OZT (Troy ounces) or kilos.

tenor - The tenor for the subscription.

amount - The amount, specified in a quantity of the metal unit.

marginBand - The margin band or price tier for the subscription.

MetalSubjectInfo

public MetalSubjectInfo(String subject,
                        String subjectPrefix,
                        String baseCurrency,
                        String termCurrency,
                        String unit,
                        String tenor,
                        String amount,
                        String marginBand)

Creates an instance of MetalSubjectInfo with a specified subject prefix and the provided parameters .

Calling this constructor is not recommended unless you are aware of all the client-side and configuration modifications required to support changing the expected format for subscription requests.

Parameters:

subject - The full subject.

subjectPrefix - The subject prefix. This will be used instead of the default prefix "PM".

baseCurrency - The first currency in the pair. This is usually the currency code for the metal, such as XAU or XAG.

termCurrency - The second currency in the pair. This is usually the currency, such as USD.

unit - The unit that the amount is specified in such, as OZT (Troy ounces) or kilos.

tenor - The tenor for the subscription.

amount - The amount, specified in a quantity of the metal unit.

marginBand - The margin band or price tier for the subscription.

Method Detail

isMetal

public boolean isMetal()

Returns true.

Specified by:

isMetal in class AbstractSubjectInfo

Returns:

True if this class represents a metal subscription, otherwise false.

getUnit

public String getUnit()

A proxy method that calls the underlying method AbstractSubjectInfo.getAmountIn().

Returns:

The unit that the amount is specified in.