com.syndloanhub.loansum.product.facility

Class Repayment

java.lang.Object

com.syndloanhub.loansum.product.facility.Repayment

All Implemented Interfaces:

LoanContractEvent, Proratable<ProratedLoanContractEvent>, org.joda.beans.Bean, org.joda.beans.ImmutableBean

public class Repayment
extends Object
implements LoanContractEvent, org.joda.beans.ImmutableBean

Repayment represents a contract-level event repaying funded principal.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Repayment(Repayment.Builder builder) Restricted constructor.

Method Summary

Modifier and Type	Method and Description
static Repayment.Builder	builder() Returns a builder used to create an instance of the bean.
boolean	equals(Object obj)
com.opengamma.strata.basics.currency.CurrencyAmount	getAmount() Gets the contract event global amount.
java.time.LocalDate	getEffectiveDate() Gets the effective date of the event.
double	getPrice() Gets the price of the repaid principal, default par.
LoanContractEventType	getType() Return type RepaymentEvent.
int	hashCode()
boolean	isInterestOnPaydown() Gets interest-on-paydown flag.
static Repayment.Meta	meta() The meta-bean for Repayment.
Repayment.Meta	metaBean()
ProratedLoanContractEvent	prorate(com.opengamma.strata.product.ProductTrade trade) Prorate a global repayment into a share based on a trade.
Repayment.Builder	toBuilder() Returns a builder that allows this bean to be mutated.
String	toString()
protected void	toString(StringBuilder buf)

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

Constructor Detail

Repayment

protected Repayment(Repayment.Builder builder)

Restricted constructor.

Parameters:

builder - the builder to copy from, not null

Method Detail

prorate

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

Prorate a global repayment into a share based on a trade.

Specified by:

prorate in interface Proratable<ProratedLoanContractEvent>

Parameters:

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

Returns:

prorated instance of type T

getType

public LoanContractEventType getType()

Return type RepaymentEvent.

Specified by:

getType in interface LoanContractEvent

Returns:

event type, e.g. borrowing or repayment

meta

public static Repayment.Meta meta()

The meta-bean for Repayment.

Returns:

the meta-bean, not null

builder

public static Repayment.Builder builder()

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

Returns:

the builder, not null

metaBean

public Repayment.Meta metaBean()

Specified by:

metaBean in interface org.joda.beans.Bean

getEffectiveDate

public java.time.LocalDate getEffectiveDate()

Gets the effective date of the event.

Specified by:

getEffectiveDate in interface LoanContractEvent

Returns:

the value of the property, not null

getAmount

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

Gets the contract event global amount.

The event global amount represents the amount of the event, and must be non-negative.

Specified by:

getAmount in interface LoanContractEvent

Returns:

the value of the property, not null

isInterestOnPaydown

public boolean isInterestOnPaydown()

Gets interest-on-paydown flag.

If true, interest on repaid principal is paid on the repayment date, not the contract end date.

Returns:

the value of the property

getPrice

public double getPrice()

Gets the price of the repaid principal, default par.

Returns:

the value of the property

toBuilder

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

toString

protected void toString(StringBuilder buf)