Package net.finmath.smartcontract.product.xml

Class StubValue

java.lang.Object

net.finmath.smartcontract.product.xml.StubValue

Direct Known Subclasses:

Stub

public class StubValue
extends Object

A type defining how a stub calculation period amount is calculated. A single floating rate tenor different to that used for the regular part of the calculation periods schedule may be specified, or two floating rate tenors many be specified. If two floating rate tenors are specified then Linear Interpolation (in accordance with the 2000 ISDA Definitions, Section 8.3 Interpolation) is assumed to apply. Alternatively, an actual known stub rate or stub amount may be specified.

Java class for StubValue complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="StubValue">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <choice>
         <element name="floatingRate" type="{http://www.fpml.org/FpML-5/confirmation}StubFloatingRate" maxOccurs="2"/>
         <element name="stubRate" type="{http://www.w3.org/2001/XMLSchema}decimal"/>
         <element name="stubAmount" type="{http://www.fpml.org/FpML-5/confirmation}Money"/>
       </choice>
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
StubValue()

Method Summary

Modifier and Type	Method	Description
List<StubFloatingRate>	getFloatingRate()	Gets the value of the floatingRate property.
Money	getStubAmount()	Gets the value of the stubAmount property.
BigDecimal	getStubRate()	Gets the value of the stubRate property.
void	setStubAmount(Money value)	Sets the value of the stubAmount property.
void	setStubRate(BigDecimal value)	Sets the value of the stubRate property.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

floatingRate

protected List<StubFloatingRate> floatingRate

stubRate

protected BigDecimal stubRate

stubAmount

protected Money stubAmount

Constructor Details

StubValue

public StubValue()

Method Details

getFloatingRate

public List<StubFloatingRate> getFloatingRate()

Gets the value of the floatingRate property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the Jakarta XML Binding object. This is why there is not a set method for the floatingRate property.

For example, to add a new item, do as follows:

    getFloatingRate().add(newItem);
 

Objects of the following type(s) are allowed in the list StubFloatingRate

getStubRate

public BigDecimal getStubRate()

Gets the value of the stubRate property.

Returns:

possible object is BigDecimal

setStubRate

public void setStubRate(BigDecimal value)

Sets the value of the stubRate property.

Parameters:

value - allowed object is BigDecimal

getStubAmount

public Money getStubAmount()

Gets the value of the stubAmount property.

Returns:

possible object is Money

setStubAmount

public void setStubAmount(Money value)

Sets the value of the stubAmount property.

Parameters:

value - allowed object is Money