Package net.finmath.smartcontract.product.xml

Class CapFloor

java.lang.Object

net.finmath.smartcontract.product.xml.Product

net.finmath.smartcontract.product.xml.CapFloor

public class CapFloor
extends Product

A type defining an interest rate cap, floor, or cap/floor strategy (e.g. collar) product.

Java class for CapFloor complex type.

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

 <complexType name="CapFloor">
   <complexContent>
     <extension base="{http://www.fpml.org/FpML-5/confirmation}Product">
       <sequence>
         <element name="capFloorStream" type="{http://www.fpml.org/FpML-5/confirmation}InterestRateStream"/>
         <element name="premium" type="{http://www.fpml.org/FpML-5/confirmation}Payment" maxOccurs="unbounded" minOccurs="0"/>
         <element name="additionalPayment" type="{http://www.fpml.org/FpML-5/confirmation}Payment" maxOccurs="unbounded" minOccurs="0"/>
         <element name="earlyTerminationProvision" type="{http://www.fpml.org/FpML-5/confirmation}EarlyTerminationProvision" minOccurs="0"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field	Description
protected List<Payment>	additionalPayment
protected InterestRateStream	capFloorStream
protected EarlyTerminationProvision	earlyTerminationProvision
protected List<Payment>	premium

Fields inherited from class net.finmath.smartcontract.product.xml.Product

assetClass, id, primaryAssetClass, productId, productType, secondaryAssetClass

Constructor Summary

Constructors

Constructor	Description
CapFloor()

Method Summary

Modifier and Type	Method	Description
List<Payment>	getAdditionalPayment()	Gets the value of the additionalPayment property.
InterestRateStream	getCapFloorStream()	Gets the value of the capFloorStream property.
EarlyTerminationProvision	getEarlyTerminationProvision()	Gets the value of the earlyTerminationProvision property.
List<Payment>	getPremium()	Gets the value of the premium property.
void	setCapFloorStream(InterestRateStream value)	Sets the value of the capFloorStream property.
void	setEarlyTerminationProvision(EarlyTerminationProvision value)	Sets the value of the earlyTerminationProvision property.

Methods inherited from class net.finmath.smartcontract.product.xml.Product

getAssetClass, getId, getPrimaryAssetClass, getProductId, getProductType, getSecondaryAssetClass, setId, setPrimaryAssetClass

Methods inherited from class java.lang.Object

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

Field Details

capFloorStream

protected InterestRateStream capFloorStream

premium

protected List<Payment> premium

additionalPayment

protected List<Payment> additionalPayment

earlyTerminationProvision

protected EarlyTerminationProvision earlyTerminationProvision

Constructor Details

CapFloor

public CapFloor()

Method Details

getCapFloorStream

public InterestRateStream getCapFloorStream()

Gets the value of the capFloorStream property.

Returns:

possible object is InterestRateStream

setCapFloorStream

public void setCapFloorStream(InterestRateStream value)

Sets the value of the capFloorStream property.

Parameters:

value - allowed object is InterestRateStream

getPremium

public List<Payment> getPremium()

Gets the value of the premium 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 premium property.

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

    getPremium().add(newItem);
 

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

getAdditionalPayment

public List<Payment> getAdditionalPayment()

Gets the value of the additionalPayment 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 additionalPayment property.

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

    getAdditionalPayment().add(newItem);
 

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

getEarlyTerminationProvision

public EarlyTerminationProvision getEarlyTerminationProvision()

Gets the value of the earlyTerminationProvision property.

Returns:

possible object is EarlyTerminationProvision

setEarlyTerminationProvision

public void setEarlyTerminationProvision(EarlyTerminationProvision value)

Sets the value of the earlyTerminationProvision property.

Parameters:

value - allowed object is EarlyTerminationProvision