Class CdsTrade
- java.lang.Object
-
- com.opengamma.strata.product.credit.CdsTrade
-
- All Implemented Interfaces:
CalculationTarget
,Resolvable<ResolvedCdsTrade>
,PortfolioItem
,ProductTrade
,ResolvableTrade<ResolvedCdsTrade>
,Trade
,Serializable
,org.joda.beans.Bean
,org.joda.beans.ImmutableBean
public final class CdsTrade extends Object implements ProductTrade, ResolvableTrade<ResolvedCdsTrade>, org.joda.beans.ImmutableBean, Serializable
A trade in a single-name credit default swap (CDS).An Over-The-Counter (OTC) trade in a
Cds
.A CDS is a financial instrument where the protection seller agrees to compensate the protection buyer when the reference entity suffers a default. The protection seller is paid premium regularly from the protection buyer until the expiry of the CDS contract or the reference entity defaults before the expiry.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
CdsTrade.Builder
The bean-builder forCdsTrade
.static class
CdsTrade.Meta
The meta-bean forCdsTrade
.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CdsTrade.Builder
builder()
Returns a builder used to create an instance of the bean.boolean
equals(Object obj)
TradeInfo
getInfo()
Gets the additional trade information, defaulted to an empty instance.Cds
getProduct()
Gets the CDS product that was agreed when the trade occurred.Optional<AdjustablePayment>
getUpfrontFee()
Gets the upfront fee of the product.int
hashCode()
static CdsTrade.Meta
meta()
The meta-bean forCdsTrade
.CdsTrade.Meta
metaBean()
ResolvedCdsTrade
resolve(ReferenceData refData)
Resolves this trade using the specified reference data.PortfolioItemSummary
summarize()
Summarizes the portfolio item.CdsTrade.Builder
toBuilder()
Returns a builder that allows this bean to be mutated.String
toString()
CdsTrade
withInfo(PortfolioItemInfo info)
Returns an instance with the specified info.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface com.opengamma.strata.product.PortfolioItem
getId
-
-
-
-
Method Detail
-
withInfo
public CdsTrade withInfo(PortfolioItemInfo info)
Description copied from interface:ProductTrade
Returns an instance with the specified info.- Specified by:
withInfo
in interfacePortfolioItem
- Specified by:
withInfo
in interfaceProductTrade
- Specified by:
withInfo
in interfaceResolvableTrade<ResolvedCdsTrade>
- Specified by:
withInfo
in interfaceTrade
- Parameters:
info
- the new info- Returns:
- the instance with the specified info
-
summarize
public PortfolioItemSummary summarize()
Description copied from interface:PortfolioItem
Summarizes the portfolio item.This provides a summary, including a human readable description.
- Specified by:
summarize
in interfacePortfolioItem
- Specified by:
summarize
in interfaceTrade
- Returns:
- the summary of the item
-
resolve
public ResolvedCdsTrade resolve(ReferenceData refData)
Description copied from interface:ResolvableTrade
Resolves this trade using the specified reference data.This converts this trade to the equivalent resolved form. All
ReferenceDataId
identifiers in this instance will be resolved. The resultingResolvedTrade
is optimized for pricing.Resolved objects may be bound to data that changes over time, such as holiday calendars. If the data changes, such as the addition of a new holiday, the resolved form will not be updated. Care must be taken when placing the resolved form in a cache or persistence layer.
- Specified by:
resolve
in interfaceResolvable<ResolvedCdsTrade>
- Specified by:
resolve
in interfaceResolvableTrade<ResolvedCdsTrade>
- Parameters:
refData
- the reference data to use when resolving- Returns:
- the resolved trade
-
meta
public static CdsTrade.Meta meta()
The meta-bean forCdsTrade
.- Returns:
- the meta-bean, not null
-
builder
public static CdsTrade.Builder builder()
Returns a builder used to create an instance of the bean.- Returns:
- the builder, not null
-
metaBean
public CdsTrade.Meta metaBean()
- Specified by:
metaBean
in interfaceorg.joda.beans.Bean
-
getInfo
public TradeInfo getInfo()
Gets the additional trade information, defaulted to an empty instance.This allows additional information to be attached to the trade.
- Specified by:
getInfo
in interfacePortfolioItem
- Specified by:
getInfo
in interfaceTrade
- Returns:
- the value of the property, not null
-
getProduct
public Cds getProduct()
Gets the CDS product that was agreed when the trade occurred.The product captures the contracted financial details of the trade.
- Specified by:
getProduct
in interfaceProductTrade
- Returns:
- the value of the property, not null
-
getUpfrontFee
public Optional<AdjustablePayment> getUpfrontFee()
Gets the upfront fee of the product.This specifies a single amount payable by the buyer to the seller. Thus the sign must be compatible with the product Pay/Receive flag.
Some CDSs, especially legacy products, are traded at par and the upfront fee is not paid.
- Returns:
- the optional value of the property, not null
-
toBuilder
public CdsTrade.Builder toBuilder()
Returns a builder that allows this bean to be mutated.- Returns:
- the mutable builder, not null
-
-