Package com.opengamma.strata.product.payment

Class BulletPayment

java.lang.Object

com.opengamma.strata.product.payment.BulletPayment

All Implemented Interfaces:

Resolvable<ResolvedBulletPayment>, Product, Serializable, org.joda.beans.Bean, org.joda.beans.ImmutableBean

public final class BulletPayment
extends Object
implements Product, Resolvable<ResolvedBulletPayment>, org.joda.beans.ImmutableBean, Serializable

A bullet payment.

An Over-The-Counter (OTC) trade where one party makes a payment to another. The reason for the payment is not captured.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BulletPayment.Builder	The bean-builder for BulletPayment.
static class	BulletPayment.Meta	The meta-bean for BulletPayment.

Method Summary

Modifier and Type	Method	Description
ImmutableSet<Currency>	allCurrencies()	Returns the set of currencies the product refers to.
static BulletPayment.Builder	builder()	Returns a builder used to create an instance of the bean.
boolean	equals(Object obj)
Currency	getCurrency()	Gets the currency of this payment.
AdjustableDate	getDate()	Gets the date that the payment is made.
PayReceive	getPayReceive()	Gets whether the payment is to be paid or received.
CurrencyAmount	getValue()	Gets the amount of the payment.
int	hashCode()
static BulletPayment.Meta	meta()	The meta-bean for BulletPayment.
BulletPayment.Meta	metaBean()
ResolvedBulletPayment	resolve(ReferenceData refData)	Resolves this object using the specified reference data.
BulletPayment.Builder	toBuilder()	Returns a builder that allows this bean to be mutated.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.joda.beans.Bean

property, propertyNames

Methods inherited from interface com.opengamma.strata.product.Product

allPaymentCurrencies, isCrossCurrency

Method Detail

getCurrency

public Currency getCurrency()

Gets the currency of this payment.

Returns:

the payment currency

allCurrencies

public ImmutableSet<Currency> allCurrencies()

Description copied from interface: Product

Returns the set of currencies the product refers to.

This returns the complete set of currencies, not just the payment currencies. For example, the sets will differ when one of the currencies is non-deliverable.

Specified by:

allCurrencies in interface Product

Returns:

the set of currencies the product refers to

resolve

public ResolvedBulletPayment resolve(ReferenceData refData)

Description copied from interface: Resolvable

Resolves this object using the specified reference data.

This converts the object implementing this interface to the equivalent resolved form. All ReferenceDataId identifiers in this instance will be resolved. The resolved form will typically be a type that is optimized for pricing.

Resolved objects may be bound to data that changes over time, such as holiday calendars. If the data changes, such as the addition of a new holiday, the resolved form will not be updated. Care must be taken when placing the resolved form in a cache or persistence layer.

Specified by:

resolve in interface Resolvable<ResolvedBulletPayment>

Parameters:

refData - the reference data to use when resolving

Returns:

the resolved instance

meta

public static BulletPayment.Meta meta()

The meta-bean for BulletPayment.

Returns:

the meta-bean, not null

builder

public static BulletPayment.Builder builder()

Returns a builder used to create an instance of the bean.

Returns:

the builder, not null

metaBean

public BulletPayment.Meta metaBean()

Specified by:

metaBean in interface org.joda.beans.Bean

getPayReceive

public PayReceive getPayReceive()

Gets whether the payment is to be paid or received.

A value of 'Pay' implies that the amount is paid to the counterparty. A value of 'Receive' implies that the amount is received from the counterparty.

Returns:

the value of the property, not null

getValue

public CurrencyAmount getValue()

Gets the amount of the payment.

The amount is unsigned, with the direction implied by payReceive.

Returns:

the value of the property, not null

getDate

public AdjustableDate getDate()

Gets the date that the payment is made.

This date should normally be a valid business day.

Returns:

the value of the property, not null

toBuilder

public BulletPayment.Builder toBuilder()

Returns a builder that allows this bean to be mutated.

Returns:

the mutable builder, not null

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object