com.syndloanhub.loansum.product.facility

Class CommitmentAdjustment

java.lang.Object

com.syndloanhub.loansum.product.facility.CommitmentAdjustment

All Implemented Interfaces:

FacilityEvent, Proratable<ProratedLoanEvent>, org.joda.beans.Bean, org.joda.beans.ImmutableBean

public final class CommitmentAdjustment
extends Object
implements FacilityEvent, org.joda.beans.ImmutableBean

An event acting on a loan facility.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CommitmentAdjustment.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.
FacilityEventType	getType() Return type of facility event CommitmentAdjustmentEvent
int	hashCode()
boolean	isPik() Gets flag indicating that this adjustment represents a capitalization from a PIK accrual.
boolean	isRefusalAllowed() Gets if true, indicates a non-prorata adjustment, e.g.
static CommitmentAdjustment.Meta	meta() The meta-bean for CommitmentAdjustment.
CommitmentAdjustment.Meta	metaBean()
ProratedLoanEvent	prorate(com.opengamma.strata.product.ProductTrade trade) Prorate a global commitment adjustment into a share based on a trade.
CommitmentAdjustment.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 ProratedLoanEvent prorate(com.opengamma.strata.product.ProductTrade trade)

Prorate a global commitment adjustment into a share based on a trade.

Specified by:

prorate in interface Proratable<ProratedLoanEvent>

Parameters:

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

Returns:

prorated instance of type T

getType

public FacilityEventType getType()

Return type of facility event CommitmentAdjustmentEvent

Specified by:

getType in interface FacilityEvent

Returns:

type of facility event, e.g. commitment adjustment

meta

public static CommitmentAdjustment.Meta meta()

The meta-bean for CommitmentAdjustment.

Returns:

the meta-bean, not null

builder

public static CommitmentAdjustment.Builder builder()

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

Returns:

the builder, not null

metaBean

public CommitmentAdjustment.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 FacilityEvent

Returns:

the value of the property, not null

getAmount

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

Gets the contract event global amount.

Returns:

the value of the property

isPik

public boolean isPik()

Gets flag indicating that this adjustment represents a capitalization from a PIK accrual.

Returns:

the value of the property

isRefusalAllowed

public boolean isRefusalAllowed()

Gets if true, indicates a non-prorata adjustment, e.g. new lender.

Returns:

the value of the property

toBuilder

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