com.syndloanhub.loansum.product.facility.prorated

Class ProratedFixedRateAccrual

java.lang.Object

com.syndloanhub.loansum.product.facility.prorated.ProratedFixedRateAccrual

All Implemented Interfaces:

ProratedAccrual, org.joda.beans.Bean, org.joda.beans.ImmutableBean

public final class ProratedFixedRateAccrual
extends Object
implements ProratedAccrual, org.joda.beans.ImmutableBean

An implementation of an interest or fee accrual featuring a fixed cash rate and PIK spread. This is a share view of the accrual.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static ProratedFixedRateAccrual.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 accrualAmount.
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 the payment frequency.
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 ProratedFixedRateAccrual.Meta	meta() The meta-bean for ProratedFixedRateAccrual.
ProratedFixedRateAccrual.Meta	metaBean()
ProratedFixedRateAccrual.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

meta

public static ProratedFixedRateAccrual.Meta meta()

The meta-bean for ProratedFixedRateAccrual.

Returns:

the meta-bean, not null

builder

public static ProratedFixedRateAccrual.Builder builder()

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

Returns:

the builder, not null

metaBean

public ProratedFixedRateAccrual.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 ProratedAccrual

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 ProratedAccrual

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 ProratedAccrual

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 ProratedAccrual

Returns:

the value of the property

getPikSpread

public double getPikSpread()

Gets the PIK rate of the accrual.

PIK interest.

Specified by:

getPikSpread in interface ProratedAccrual

Returns:

the value of the property

getAccrualAmount

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

Gets the accrualAmount.

Specified by:

getAccrualAmount in interface ProratedAccrual

Returns:

the value of the property

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 ProratedAccrual

Returns:

the value of the property, not null

getPaymentFrequency

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

Gets the payment frequency.

Specified by:

getPaymentFrequency in interface ProratedAccrual

Returns:

the value of the property

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 ProratedAccrual

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 ProratedAccrual

Returns:

the value of the property

toBuilder

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