public final class ProratedFloatingRateAccrual extends Object implements ProratedAccrual, org.joda.beans.ImmutableBean
Modifier and Type | Class and Description |
---|---|
static class |
ProratedFloatingRateAccrual.Builder
The bean-builder for
ProratedFloatingRateAccrual . |
static class |
ProratedFloatingRateAccrual.Meta
The meta-bean for
ProratedFloatingRateAccrual . |
Modifier and Type | Method and Description |
---|---|
static ProratedFloatingRateAccrual.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.
|
double |
getBaseRate()
Gets the base rate, fixed based on the rate index.
|
com.opengamma.strata.basics.date.DayCount |
getDayCount()
Gets the day count convention.
|
java.time.LocalDate |
getEndDate()
Gets the end date of the accrual.
|
com.opengamma.strata.basics.index.RateIndex |
getIndex()
Gets the type of index, e.g.
|
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.
|
double |
getSpread()
Gets the spread over the index.
|
java.time.LocalDate |
getStartDate()
Gets the start date of the accrual.
|
int |
hashCode() |
static ProratedFloatingRateAccrual.Meta |
meta()
The meta-bean for
ProratedFloatingRateAccrual . |
ProratedFloatingRateAccrual.Meta |
metaBean() |
ProratedFloatingRateAccrual.Builder |
toBuilder()
Returns a builder that allows this bean to be mutated.
|
String |
toString() |
public static ProratedFloatingRateAccrual.Meta meta()
ProratedFloatingRateAccrual
.public static ProratedFloatingRateAccrual.Builder builder()
public ProratedFloatingRateAccrual.Meta metaBean()
metaBean
in interface org.joda.beans.Bean
public java.time.LocalDate getStartDate()
Interest accrues from this date.
getStartDate
in interface ProratedAccrual
public java.time.LocalDate getEndDate()
Interest accrues to this date.
getEndDate
in interface ProratedAccrual
public Optional<java.time.LocalDate> getPaymentDate()
getPaymentDate
in interface ProratedAccrual
public double getAllInRate()
Cash interest "all-in" rate. Does NOT include PIK.
getAllInRate
in interface ProratedAccrual
public double getPikSpread()
PIK interest.
getPikSpread
in interface ProratedAccrual
public com.opengamma.strata.basics.currency.CurrencyAmount getAccrualAmount()
getAccrualAmount
in interface ProratedAccrual
public com.opengamma.strata.basics.date.DayCount getDayCount()
This is used to convert dates to a numerical value.
getDayCount
in interface ProratedAccrual
public com.opengamma.strata.basics.schedule.Frequency getPaymentFrequency()
getPaymentFrequency
in interface ProratedAccrual
public com.opengamma.strata.basics.currency.CurrencyAmount getPaymentProjection()
The global amount represents the principal amount, and must be non-negative.
The currency of the global amount is specified by currency
.
getPaymentProjection
in interface ProratedAccrual
public com.opengamma.strata.basics.currency.CurrencyAmount getPikProjection()
The global amount represents the principal amount, and must be non-negative.
The currency of the global amount is specified by currency
.
getPikProjection
in interface ProratedAccrual
public com.opengamma.strata.basics.index.RateIndex getIndex()
public double getBaseRate()
public double getSpread()
public ProratedFloatingRateAccrual.Builder toBuilder()
Copyright © 2018. All rights reserved.