com.syndloanhub.loansum.product.facility

Class FixedRateAccrual

java.lang.Object

com.syndloanhub.loansum.product.facility.FixedRateAccrual

All Implemented Interfaces:

Accrual, Proratable<ProratedAccrual>, org.joda.beans.Bean, org.joda.beans.ImmutableBean

public final class FixedRateAccrual
extends Object
implements Accrual, org.joda.beans.ImmutableBean

An implementation of an interest or fee accrual featuring a fixed cash rate and PIK spread. This is a global view of the accrual; a prorated version may be produced via the prorate function based on a specific trade. In addition, a sub-accrual structure may be constructed via the rebuild function. For example, an interest contract with a repayment embedded may be rebuilt into 2 sub-accruals implementing the pre and post-paydown accruals.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static FixedRateAccrual.Builder	builder() Returns a builder used to create an instance of the bean.
boolean	equals(Object obj)
com.opengamma.strata.basics.currency.CurrencyAmount	getAccrualAmount() Gets the accrual notional amount and currency.
double	getAllInRate() Gets the cash rate of the accrual.
com.opengamma.strata.basics.date.DayCount	getDayCount() Gets the day count convention.
java.time.LocalDate	getEndDate() Gets the end date of the accrual.
Optional<java.time.LocalDate>	getPaymentDate() Gets the payment date, optional.
com.opengamma.strata.basics.schedule.Frequency	getPaymentFrequency() Gets frequency of accrual period.
com.opengamma.strata.basics.currency.CurrencyAmount	getPaymentProjection() Gets projected interest amount.
com.opengamma.strata.basics.currency.CurrencyAmount	getPikProjection() Gets projected PIK amount.
double	getPikSpread() Gets the PIK rate of the accrual.
java.time.LocalDate	getStartDate() Gets the start date of the accrual.
int	hashCode()
static FixedRateAccrual.Meta	meta() The meta-bean for FixedRateAccrual.
FixedRateAccrual.Meta	metaBean()
ProratedFixedRateAccrual	prorate(com.opengamma.strata.product.ProductTrade trade) Prorate a global accrual into a share based on given trade.
Accrual	rebuild(java.time.LocalDate startDate, java.time.LocalDate endDate, com.opengamma.strata.basics.currency.CurrencyAmount accrualAmount, java.time.LocalDate paymentDate) Construct a modified instance of this accrual given the new period and amount.
com.opengamma.strata.collect.tuple.Pair<Accrual,Accrual>	split() Split an accrual into cash and PIK sub-accruals.
FixedRateAccrual.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

prorate

public ProratedFixedRateAccrual prorate(com.opengamma.strata.product.ProductTrade trade)

Prorate a global accrual into a share based on given trade.

Specified by:

prorate in interface Proratable<ProratedAccrual>

Parameters:

trade - buy or sell trade representing a full or partial allocation

Returns:

prorated instance of type T

rebuild

public Accrual rebuild(java.time.LocalDate startDate,
                       java.time.LocalDate endDate,
                       com.opengamma.strata.basics.currency.CurrencyAmount accrualAmount,
                       java.time.LocalDate paymentDate)

Construct a modified instance of this accrual given the new period and amount.

Specified by:

rebuild in interface Accrual

Parameters:

startDate - revised start date

endDate - revised end date

accrualAmount - revised accrual amount

paymentDate - revised payment date, may be null

Returns:

accrual with revised period and amount

split

public com.opengamma.strata.collect.tuple.Pair<Accrual,Accrual> split()

Split an accrual into cash and PIK sub-accruals. This is needed as a PIK accrual will always span the full period but cash typically will commence on the actual settlement date.

Specified by:

split in interface Accrual

Returns:

pair of accruals: cash first, PIK second

meta

public static FixedRateAccrual.Meta meta()

The meta-bean for FixedRateAccrual.

Returns:

the meta-bean, not null

builder

public static FixedRateAccrual.Builder builder()

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

Returns:

the builder, not null

metaBean

public FixedRateAccrual.Meta metaBean()

Specified by:

metaBean in interface org.joda.beans.Bean

getStartDate

public java.time.LocalDate getStartDate()

Gets the start date of the accrual.

Interest accrues from this date.

Specified by:

getStartDate in interface Accrual

Returns:

the value of the property, not null

getEndDate

public java.time.LocalDate getEndDate()

Gets the end date of the accrual.

Interest accrues to this date.

Specified by:

getEndDate in interface Accrual

Returns:

the value of the property, not null

getPaymentDate

public Optional<java.time.LocalDate> getPaymentDate()

Gets the payment date, optional.

Specified by:

getPaymentDate in interface Accrual

Returns:

the optional value of the property, not null

getAllInRate

public double getAllInRate()

Gets the cash rate of the accrual.

Cash interest "all-in" rate. Does NOT include PIK.

Specified by:

getAllInRate in interface Accrual

Returns:

the value of the property

getPikSpread

public double getPikSpread()

Gets the PIK rate of the accrual.

PIK interest.

Specified by:

getPikSpread in interface Accrual

Returns:

the value of the property

getAccrualAmount

public com.opengamma.strata.basics.currency.CurrencyAmount getAccrualAmount()

Gets the accrual notional amount and currency.

Specified by:

getAccrualAmount in interface Accrual

Returns:

the value of the property, not null

getDayCount

public com.opengamma.strata.basics.date.DayCount getDayCount()

Gets the day count convention.

This is used to convert dates to a numerical value.

Specified by:

getDayCount in interface Accrual

Returns:

the value of the property, not null

getPaymentFrequency

public com.opengamma.strata.basics.schedule.Frequency getPaymentFrequency()

Gets frequency of accrual period.

Specified by:

getPaymentFrequency in interface Accrual

Returns:

the value of the property, not null

getPaymentProjection

public com.opengamma.strata.basics.currency.CurrencyAmount getPaymentProjection()

Gets projected interest amount.

The global amount represents the principal amount, and must be non-negative. The currency of the global amount is specified by currency.

Specified by:

getPaymentProjection in interface Accrual

Returns:

the value of the property

getPikProjection

public com.opengamma.strata.basics.currency.CurrencyAmount getPikProjection()

Gets projected PIK amount.

The global amount represents the principal amount, and must be non-negative. The currency of the global amount is specified by currency.

Specified by:

getPikProjection in interface Accrual

Returns:

the value of the property

toBuilder

public FixedRateAccrual.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