Package com.opengamma.strata.basics.currency

Class Payment

java.lang.Object

com.opengamma.strata.basics.currency.Payment

All Implemented Interfaces:

FxConvertible<Payment>, Serializable, org.joda.beans.Bean, org.joda.beans.ImmutableBean

public final class Payment
extends Object
implements FxConvertible<Payment>, org.joda.beans.ImmutableBean, Serializable

A single payment of a known amount on a specific date.

This class represents a payment, where the payment date and amount are known. A negative value indicates the amount is to be paid while a positive value indicates the amount is received.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
Payment	adjustDate(TemporalAdjuster adjuster)	Adjusts the payment date using the rules of the specified adjuster.
static Payment.Builder	builder()	Returns a builder used to create an instance of the bean.
Payment	convertedTo(Currency resultCurrency, FxRateProvider rateProvider)	Converts this payment to an equivalent payment in the specified currency.
boolean	equals(Object obj)
double	getAmount()	Gets the amount of the payment.
Currency	getCurrency()	Gets the currency of the payment.
LocalDate	getDate()	Gets the date that the payment is made.
CurrencyAmount	getValue()	Gets the amount of the payment.
int	hashCode()
static Payment.Meta	meta()	The meta-bean for Payment.
Payment.Meta	metaBean()
Payment	negated()	Returns a copy of this Payment with the value negated.
static Payment	of(CurrencyAmount value, LocalDate date)	Obtains an instance representing an amount.
static Payment	of(Currency currency, double amount, LocalDate date)	Obtains an instance representing an amount.
static Payment	ofPay(CurrencyAmount value, LocalDate date)	Obtains an instance representing an amount to be paid.
static Payment	ofReceive(CurrencyAmount value, LocalDate date)	Obtains an instance representing an amount to be received.
Payment.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

Method Detail

of

public static Payment of(Currency currency,
                         double amount,
                         LocalDate date)

Obtains an instance representing an amount.

Whether the payment is pay or receive is determined by the sign of the specified amount.

Parameters:

currency - the currency of the payment

amount - the amount of the payment

date - the date that the payment is made

Returns:

the payment instance

of

public static Payment of(CurrencyAmount value,
                         LocalDate date)

Obtains an instance representing an amount.

Whether the payment is pay or receive is determined by the sign of the specified amount.

Parameters:

value - the amount of the payment

date - the date that the payment is made

Returns:

the payment instance

ofPay

public static Payment ofPay(CurrencyAmount value,
                            LocalDate date)

Obtains an instance representing an amount to be paid.

The sign of the amount will be normalized to be negative, indicating a payment.

Parameters:

value - the amount of the payment

date - the date that the payment is made

Returns:

the payment instance

ofReceive

public static Payment ofReceive(CurrencyAmount value,
                                LocalDate date)

Obtains an instance representing an amount to be received.

The sign of the amount will be normalized to be positive, indicating receipt.

Parameters:

value - the amount of the payment

date - the date that the payment is made

Returns:

the payment instance

getCurrency

public Currency getCurrency()

Gets the currency of the payment.

This simply returns getValue().getCurrency().

Returns:

the currency of the payment

getAmount

public double getAmount()

Gets the amount of the payment.

The payment value is signed. A negative value indicates a payment while a positive value indicates receipt.

This simply returns getValue().getAmount().

Returns:

the amount of the payment

adjustDate

public Payment adjustDate(TemporalAdjuster adjuster)

Adjusts the payment date using the rules of the specified adjuster.

The adjuster is typically an instance of BusinessDayAdjustment. If the date is unchanged by the adjuster, this payment will be returned.

Parameters:

adjuster - the adjuster to apply to the payment date

Returns:

the adjusted payment

negated

public Payment negated()

Returns a copy of this Payment with the value negated.

This takes this payment and negates it.

This instance is immutable and unaffected by this method.

Returns:

a payment based on this with the value negated

convertedTo

public Payment convertedTo(Currency resultCurrency,
                           FxRateProvider rateProvider)

Converts this payment to an equivalent payment in the specified currency.

The result will be expressed in terms of the given currency. If conversion is needed, the provider will be used to supply the FX rate.

Specified by:

convertedTo in interface FxConvertible<Payment>

Parameters:

resultCurrency - the currency of the result

rateProvider - the provider of FX rates

Returns:

the converted instance, in the specified currency

Throws:

RuntimeException - if no FX rate could be found

meta

public static Payment.Meta meta()

The meta-bean for Payment.

Returns:

the meta-bean, not null

builder

public static Payment.Builder builder()

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

Returns:

the builder, not null

metaBean

public Payment.Meta metaBean()

Specified by:

metaBean in interface org.joda.beans.Bean

getValue

public CurrencyAmount getValue()

Gets the amount of the payment.

The amount is signed. A negative value indicates the amount is to be paid while a positive value indicates the amount is received.

Returns:

the value of the property, not null

getDate

public LocalDate 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 Payment.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