Class Swaption
java.lang.Object
net.finmath.smartcontract.product.xml.Product
net.finmath.smartcontract.product.xml.Swaption
A type to define an option on a swap.
Java class for Swaption complex type.
The following schema fragment specifies the expected content contained within this class.
<complexType name="Swaption"> <complexContent> <extension base="{http://www.fpml.org/FpML-5/confirmation}Product"> <sequence> <group ref="{http://www.fpml.org/FpML-5/confirmation}BuyerSeller.model"/> <element name="premium" type="{http://www.fpml.org/FpML-5/confirmation}Payment" maxOccurs="unbounded" minOccurs="0"/> <element ref="{http://www.fpml.org/FpML-5/confirmation}exercise"/> <element name="exerciseProcedure" type="{http://www.fpml.org/FpML-5/confirmation}ExerciseProcedure" minOccurs="0"/> <element name="calculationAgent" type="{http://www.fpml.org/FpML-5/confirmation}CalculationAgent" minOccurs="0"/> <choice minOccurs="0"> <element name="cashSettlement" type="{http://www.fpml.org/FpML-5/confirmation}CashSettlement"/> <element name="physicalSettlement" type="{http://www.fpml.org/FpML-5/confirmation}SwaptionPhysicalSettlement"/> </choice> <element name="swaptionStraddle" type="{http://www.w3.org/2001/XMLSchema}boolean"/> <element name="swaptionAdjustedDates" type="{http://www.fpml.org/FpML-5/confirmation}SwaptionAdjustedDates" minOccurs="0"/> <element name="swap" type="{http://www.fpml.org/FpML-5/confirmation}Swap"/> </sequence> </extension> </complexContent> </complexType>
-
Field Summary
Modifier and TypeFieldDescriptionprotected AccountReference
protected PartyReference
protected CalculationAgent
protected CashSettlement
protected jakarta.xml.bind.JAXBElement
<? extends Exercise> protected ExerciseProcedure
protected SwaptionPhysicalSettlement
protected AccountReference
protected PartyReference
protected Swap
protected SwaptionAdjustedDates
protected boolean
Fields inherited from class net.finmath.smartcontract.product.xml.Product
assetClass, id, primaryAssetClass, productId, productType, secondaryAssetClass
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGets the value of the buyerAccountReference property.Gets the value of the buyerPartyReference property.Gets the value of the calculationAgent property.Gets the value of the cashSettlement property.jakarta.xml.bind.JAXBElement
<? extends Exercise> Gets the value of the exercise property.Gets the value of the exerciseProcedure property.Gets the value of the physicalSettlement property.Gets the value of the premium property.Gets the value of the sellerAccountReference property.Gets the value of the sellerPartyReference property.getSwap()
Gets the value of the swap property.Gets the value of the swaptionAdjustedDates property.boolean
Gets the value of the swaptionStraddle property.void
Sets the value of the buyerAccountReference property.void
Sets the value of the buyerPartyReference property.void
Sets the value of the calculationAgent property.void
setCashSettlement
(CashSettlement value) Sets the value of the cashSettlement property.void
setExercise
(jakarta.xml.bind.JAXBElement<? extends Exercise> value) Sets the value of the exercise property.void
Sets the value of the exerciseProcedure property.void
Sets the value of the physicalSettlement property.void
Sets the value of the sellerAccountReference property.void
Sets the value of the sellerPartyReference property.void
Sets the value of the swap property.void
Sets the value of the swaptionAdjustedDates property.void
setSwaptionStraddle
(boolean value) Sets the value of the swaptionStraddle property.Methods inherited from class net.finmath.smartcontract.product.xml.Product
getAssetClass, getId, getPrimaryAssetClass, getProductId, getProductType, getSecondaryAssetClass, setId, setPrimaryAssetClass
-
Field Details
-
buyerPartyReference
-
buyerAccountReference
-
sellerPartyReference
-
sellerAccountReference
-
exercise
-
exerciseProcedure
-
calculationAgent
-
cashSettlement
-
physicalSettlement
-
swaptionStraddle
protected boolean swaptionStraddle -
swaptionAdjustedDates
-
swap
-
-
Constructor Details
-
Swaption
public Swaption()
-
-
Method Details
-
getBuyerPartyReference
Gets the value of the buyerPartyReference property.- Returns:
- possible object is
PartyReference
-
setBuyerPartyReference
Sets the value of the buyerPartyReference property.- Parameters:
value
- allowed object isPartyReference
-
getBuyerAccountReference
Gets the value of the buyerAccountReference property.- Returns:
- possible object is
AccountReference
-
setBuyerAccountReference
Sets the value of the buyerAccountReference property.- Parameters:
value
- allowed object isAccountReference
-
getSellerPartyReference
Gets the value of the sellerPartyReference property.- Returns:
- possible object is
PartyReference
-
setSellerPartyReference
Sets the value of the sellerPartyReference property.- Parameters:
value
- allowed object isPartyReference
-
getSellerAccountReference
Gets the value of the sellerAccountReference property.- Returns:
- possible object is
AccountReference
-
setSellerAccountReference
Sets the value of the sellerAccountReference property.- Parameters:
value
- allowed object isAccountReference
-
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
-
getExercise
Gets the value of the exercise property.- Returns:
- possible object is
JAXBElement
<
BermudaExercise
>
JAXBElement
<
EuropeanExercise
>
JAXBElement
<
AmericanExercise
>
JAXBElement
<
Exercise
>
-
setExercise
Sets the value of the exercise property.- Parameters:
value
- allowed object isJAXBElement
<
BermudaExercise
>
JAXBElement
<
EuropeanExercise
>
JAXBElement
<
AmericanExercise
>
JAXBElement
<
Exercise
>
-
getExerciseProcedure
Gets the value of the exerciseProcedure property.- Returns:
- possible object is
ExerciseProcedure
-
setExerciseProcedure
Sets the value of the exerciseProcedure property.- Parameters:
value
- allowed object isExerciseProcedure
-
getCalculationAgent
Gets the value of the calculationAgent property.- Returns:
- possible object is
CalculationAgent
-
setCalculationAgent
Sets the value of the calculationAgent property.- Parameters:
value
- allowed object isCalculationAgent
-
getCashSettlement
Gets the value of the cashSettlement property.- Returns:
- possible object is
CashSettlement
-
setCashSettlement
Sets the value of the cashSettlement property.- Parameters:
value
- allowed object isCashSettlement
-
getPhysicalSettlement
Gets the value of the physicalSettlement property.- Returns:
- possible object is
SwaptionPhysicalSettlement
-
setPhysicalSettlement
Sets the value of the physicalSettlement property.- Parameters:
value
- allowed object isSwaptionPhysicalSettlement
-
isSwaptionStraddle
public boolean isSwaptionStraddle()Gets the value of the swaptionStraddle property. -
setSwaptionStraddle
public void setSwaptionStraddle(boolean value) Sets the value of the swaptionStraddle property. -
getSwaptionAdjustedDates
Gets the value of the swaptionAdjustedDates property.- Returns:
- possible object is
SwaptionAdjustedDates
-
setSwaptionAdjustedDates
Sets the value of the swaptionAdjustedDates property.- Parameters:
value
- allowed object isSwaptionAdjustedDates
-
getSwap
-
setSwap
-