Package cdm.product.asset

Class StubValue.StubValueBuilderImpl

java.lang.Object

cdm.product.asset.StubValue.StubValueBuilderImpl

All Implemented Interfaces:

StubValue, StubValue.StubValueBuilder, com.rosetta.model.lib.RosettaModelObject, com.rosetta.model.lib.RosettaModelObjectBuilder

Enclosing interface:

StubValue

public static class StubValue.StubValueBuilderImpl
extends Object
implements StubValue.StubValueBuilder

Builder Implementation of StubValue

Nested Class Summary

Nested classes/interfaces inherited from interface cdm.product.asset.StubValue

StubValue.StubValueBuilder, StubValue.StubValueBuilderImpl, StubValue.StubValueImpl

Field Summary

Fields

Modifier and Type	Field	Description
protected List<StubFloatingRate.StubFloatingRateBuilder>	floatingRate
protected Money.MoneyBuilder	stubAmount
protected BigDecimal	stubRate

Fields inherited from interface cdm.product.asset.StubValue

metaData

Constructor Summary

Constructors

Constructor	Description
StubValueBuilderImpl()

Method Summary

Modifier and Type	Method	Description
StubValue.StubValueBuilder	addFloatingRate(StubFloatingRate _floatingRate)
StubValue.StubValueBuilder	addFloatingRate(StubFloatingRate _floatingRate, int idx)
StubValue.StubValueBuilder	addFloatingRate(List<? extends StubFloatingRate> floatingRates)
StubValue	build()	Build Methods
boolean	equals(Object o)
List<? extends StubFloatingRate.StubFloatingRateBuilder>	getFloatingRate()	The rates to be applied to the initial or final stub may be the linear interpolation of two different rates.
StubFloatingRate.StubFloatingRateBuilder	getOrCreateFloatingRate(int index)
Money.MoneyBuilder	getOrCreateStubAmount()
Money.MoneyBuilder	getStubAmount()	An actual amount to apply for the initial or final stub period may have been agreed between the two parties.
BigDecimal	getStubRate()	An actual rate to apply for the initial or final stub period may have been agreed between the principal parties (in a similar way to how an initial rate may have been agreed for the first regular period).
boolean	hasData()
int	hashCode()
StubValue.StubValueBuilder	merge(com.rosetta.model.lib.RosettaModelObjectBuilder other, com.rosetta.model.lib.process.BuilderMerger merger)
StubValue.StubValueBuilder	prune()
StubValue.StubValueBuilder	setFloatingRate(List<? extends StubFloatingRate> floatingRates)
StubValue.StubValueBuilder	setStubAmount(Money _stubAmount)
StubValue.StubValueBuilder	setStubRate(BigDecimal _stubRate)
StubValue.StubValueBuilder	toBuilder()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.rosetta.model.lib.RosettaModelObject

processRosetta, processRosetta

Methods inherited from interface com.rosetta.model.lib.RosettaModelObjectBuilder

getIndex, processRosetta, processRosetta

Methods inherited from interface cdm.product.asset.StubValue

getType, metaData, process

Methods inherited from interface cdm.product.asset.StubValue.StubValueBuilder

process

Field Details

floatingRate

protected List<StubFloatingRate.StubFloatingRateBuilder> floatingRate

stubRate

protected BigDecimal stubRate

stubAmount

protected Money.MoneyBuilder stubAmount

Constructor Details

StubValueBuilderImpl

public StubValueBuilderImpl()

Method Details

getFloatingRate

@RosettaAttribute("floatingRate")
@RuneAttribute("floatingRate")
public List<? extends StubFloatingRate.StubFloatingRateBuilder> getFloatingRate()

Description copied from interface: StubValue

The rates to be applied to the initial or final stub may be the linear interpolation of two different rates. While the majority of the time, the rate indices will be the same as that specified in the stream and only the tenor itself will be different, it is possible to specift two different rates. For example, a 2 month stub period may use the linear interpolation of a 1 month and 3 month rate. The different rates would be specified in this component. Note that a maximum of two rates can be specified. If a stub period uses the same floating rate index, including tenor, as the regular calculation periods then this should not be specified again within this component, i.e. the stub calculation period amount component may not need to be specified even if there is an initial or final stub period. If a stub period uses a different floating rate index compared to the regular calculation periods then this should be specified within this component. If specified here, they are likely to have id attributes, allowing them to be referenced from within the cashflows component.

Specified by:

getFloatingRate in interface StubValue

Specified by:

getFloatingRate in interface StubValue.StubValueBuilder

getOrCreateFloatingRate

public StubFloatingRate.StubFloatingRateBuilder getOrCreateFloatingRate(int index)

Specified by:

getOrCreateFloatingRate in interface StubValue.StubValueBuilder

getStubRate

@RosettaAttribute("stubRate")
@RuneAttribute("stubRate")
public BigDecimal getStubRate()

Description copied from interface: StubValue

An actual rate to apply for the initial or final stub period may have been agreed between the principal parties (in a similar way to how an initial rate may have been agreed for the first regular period). If an actual stub rate has been agreed then it would be included in this component. It will be a per annum rate, expressed as a decimal. A stub rate of 5% would be represented as 0.05.

Specified by:

getStubRate in interface StubValue

getStubAmount

@RosettaAttribute("stubAmount")
@RuneAttribute("stubAmount")
public Money.MoneyBuilder getStubAmount()

Description copied from interface: StubValue

An actual amount to apply for the initial or final stub period may have been agreed between the two parties. If an actual stub amount has been agreed then it would be included in this component.

Specified by:

getStubAmount in interface StubValue

Specified by:

getStubAmount in interface StubValue.StubValueBuilder

getOrCreateStubAmount

public Money.MoneyBuilder getOrCreateStubAmount()

Specified by:

getOrCreateStubAmount in interface StubValue.StubValueBuilder

addFloatingRate

@RosettaAttribute("floatingRate")
@RuneAttribute("floatingRate")
public StubValue.StubValueBuilder addFloatingRate(StubFloatingRate _floatingRate)

Specified by:

addFloatingRate in interface StubValue.StubValueBuilder

addFloatingRate

public StubValue.StubValueBuilder addFloatingRate(StubFloatingRate _floatingRate,
 int idx)

Specified by:

addFloatingRate in interface StubValue.StubValueBuilder

addFloatingRate

public StubValue.StubValueBuilder addFloatingRate(List<? extends StubFloatingRate> floatingRates)

Specified by:

addFloatingRate in interface StubValue.StubValueBuilder

setFloatingRate

@RuneAttribute("floatingRate")
public StubValue.StubValueBuilder setFloatingRate(List<? extends StubFloatingRate> floatingRates)

Specified by:

setFloatingRate in interface StubValue.StubValueBuilder

setStubRate

@RosettaAttribute("stubRate")
@RuneAttribute("stubRate")
public StubValue.StubValueBuilder setStubRate(BigDecimal _stubRate)

Specified by:

setStubRate in interface StubValue.StubValueBuilder

setStubAmount

@RosettaAttribute("stubAmount")
@RuneAttribute("stubAmount")
public StubValue.StubValueBuilder setStubAmount(Money _stubAmount)

Specified by:

setStubAmount in interface StubValue.StubValueBuilder

build

public StubValue build()

Description copied from interface: StubValue

Build Methods

Specified by:

build in interface com.rosetta.model.lib.RosettaModelObject

Specified by:

build in interface StubValue

toBuilder

public StubValue.StubValueBuilder toBuilder()

Specified by:

toBuilder in interface com.rosetta.model.lib.RosettaModelObject

Specified by:

toBuilder in interface StubValue

prune

public StubValue.StubValueBuilder prune()

Specified by:

prune in interface com.rosetta.model.lib.RosettaModelObjectBuilder

Specified by:

prune in interface StubValue.StubValueBuilder

hasData

public boolean hasData()

Specified by:

hasData in interface com.rosetta.model.lib.RosettaModelObjectBuilder

merge

public StubValue.StubValueBuilder merge(com.rosetta.model.lib.RosettaModelObjectBuilder other,
 com.rosetta.model.lib.process.BuilderMerger merger)

Specified by:

merge in interface com.rosetta.model.lib.RosettaModelObjectBuilder

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object