Package net.finmath.smartcontract.product.xml

Class Swap

java.lang.Object

net.finmath.smartcontract.product.xml.Product

net.finmath.smartcontract.product.xml.Swap

public class Swap
extends Product

A type defining swap streams and additional payments between the principal parties involved in the swap.

Java class for Swap complex type.

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

 <complexType name="Swap">
   <complexContent>
     <extension base="{http://www.fpml.org/FpML-5/confirmation}Product">
       <sequence>
         <element name="swapStream" type="{http://www.fpml.org/FpML-5/confirmation}InterestRateStream" maxOccurs="unbounded"/>
         <element name="earlyTerminationProvision" type="{http://www.fpml.org/FpML-5/confirmation}EarlyTerminationProvision" minOccurs="0"/>
         <element name="cancelableProvision" type="{http://www.fpml.org/FpML-5/confirmation}CancelableProvision" minOccurs="0"/>
         <element name="extendibleProvision" type="{http://www.fpml.org/FpML-5/confirmation}ExtendibleProvision" minOccurs="0"/>
         <element name="additionalPayment" type="{http://www.fpml.org/FpML-5/confirmation}Payment" maxOccurs="unbounded" minOccurs="0"/>
         <element name="additionalTerms" type="{http://www.fpml.org/FpML-5/confirmation}SwapAdditionalTerms" minOccurs="0"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field	Description
protected List<Payment>	additionalPayment
protected SwapAdditionalTerms	additionalTerms
protected CancelableProvision	cancelableProvision
protected EarlyTerminationProvision	earlyTerminationProvision
protected ExtendibleProvision	extendibleProvision
protected List<InterestRateStream>	swapStream

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

assetClass, id, primaryAssetClass, productId, productType, secondaryAssetClass

Constructor Summary

Constructors

Constructor	Description
Swap()

Method Summary

Modifier and Type	Method	Description
List<Payment>	getAdditionalPayment()	Gets the value of the additionalPayment property.
SwapAdditionalTerms	getAdditionalTerms()	Gets the value of the additionalTerms property.
CancelableProvision	getCancelableProvision()	Gets the value of the cancelableProvision property.
EarlyTerminationProvision	getEarlyTerminationProvision()	Gets the value of the earlyTerminationProvision property.
ExtendibleProvision	getExtendibleProvision()	Gets the value of the extendibleProvision property.
List<InterestRateStream>	getSwapStream()	Gets the value of the swapStream property.
void	setAdditionalTerms(SwapAdditionalTerms value)	Sets the value of the additionalTerms property.
void	setCancelableProvision(CancelableProvision value)	Sets the value of the cancelableProvision property.
void	setEarlyTerminationProvision(EarlyTerminationProvision value)	Sets the value of the earlyTerminationProvision property.
void	setExtendibleProvision(ExtendibleProvision value)	Sets the value of the extendibleProvision 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

swapStream

protected List<InterestRateStream> swapStream

earlyTerminationProvision

protected EarlyTerminationProvision earlyTerminationProvision

cancelableProvision

protected CancelableProvision cancelableProvision

extendibleProvision

protected ExtendibleProvision extendibleProvision

additionalPayment

protected List<Payment> additionalPayment

additionalTerms

protected SwapAdditionalTerms additionalTerms

Constructor Details

Swap

public Swap()

Method Details

getSwapStream

public List<InterestRateStream> getSwapStream()

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

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

    getSwapStream().add(newItem);
 

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

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

getCancelableProvision

public CancelableProvision getCancelableProvision()

Gets the value of the cancelableProvision property.

Returns:

possible object is CancelableProvision

setCancelableProvision

public void setCancelableProvision(CancelableProvision value)

Sets the value of the cancelableProvision property.

Parameters:

value - allowed object is CancelableProvision

getExtendibleProvision

public ExtendibleProvision getExtendibleProvision()

Gets the value of the extendibleProvision property.

Returns:

possible object is ExtendibleProvision

setExtendibleProvision

public void setExtendibleProvision(ExtendibleProvision value)

Sets the value of the extendibleProvision property.

Parameters:

value - allowed object is ExtendibleProvision

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

getAdditionalTerms

public SwapAdditionalTerms getAdditionalTerms()

Gets the value of the additionalTerms property.

Returns:

possible object is SwapAdditionalTerms

setAdditionalTerms

public void setAdditionalTerms(SwapAdditionalTerms value)

Sets the value of the additionalTerms property.

Parameters:

value - allowed object is SwapAdditionalTerms