Package com.opengamma.strata.market.param

Class CurrencyParameterSensitivity.Builder

java.lang.Object

org.joda.beans.impl.direct.DirectFieldsBeanBuilder<CurrencyParameterSensitivity>

com.opengamma.strata.market.param.CurrencyParameterSensitivity.Builder

All Implemented Interfaces:

org.joda.beans.BeanBuilder<CurrencyParameterSensitivity>

Enclosing class:

CurrencyParameterSensitivity

public static final class CurrencyParameterSensitivity.Builder
extends org.joda.beans.impl.direct.DirectFieldsBeanBuilder<CurrencyParameterSensitivity>

The bean-builder for CurrencyParameterSensitivity.

Method Summary

Modifier and Type	Method	Description
CurrencyParameterSensitivity	build()
CurrencyParameterSensitivity.Builder	currency(Currency currency)	Sets the currency of the sensitivity.
Object	get(String propertyName)
CurrencyParameterSensitivity.Builder	marketDataName(MarketDataName<?> marketDataName)	Sets the market data name.
CurrencyParameterSensitivity.Builder	parameterMetadata(ParameterMetadata... parameterMetadata)	Sets the parameterMetadata property in the builder from an array of objects.
CurrencyParameterSensitivity.Builder	parameterMetadata(List<? extends ParameterMetadata> parameterMetadata)	Sets the list of parameter metadata.
CurrencyParameterSensitivity.Builder	parameterSplit(ParameterSize... parameterSplit)	Sets the parameterSplit property in the builder from an array of objects.
CurrencyParameterSensitivity.Builder	parameterSplit(List<ParameterSize> parameterSplit)	Sets the split of parameters between the underlying parameterized data.
CurrencyParameterSensitivity.Builder	sensitivity(DoubleArray sensitivity)	Sets the parameter sensitivity values.
CurrencyParameterSensitivity.Builder	set(String propertyName, Object newValue)
CurrencyParameterSensitivity.Builder	set(org.joda.beans.MetaProperty<?> property, Object value)
String	toString()

Methods inherited from class org.joda.beans.impl.direct.DirectFieldsBeanBuilder

get

Methods inherited from class java.lang.Object

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

Method Detail

get

public Object get(String propertyName)

Specified by:

get in interface org.joda.beans.BeanBuilder<CurrencyParameterSensitivity>

Overrides:

get in class org.joda.beans.impl.direct.DirectFieldsBeanBuilder<CurrencyParameterSensitivity>

set

public CurrencyParameterSensitivity.Builder set(String propertyName,
                                                Object newValue)

set

public CurrencyParameterSensitivity.Builder set(org.joda.beans.MetaProperty<?> property,
                                                Object value)

Specified by:

set in interface org.joda.beans.BeanBuilder<CurrencyParameterSensitivity>

Overrides:

set in class org.joda.beans.impl.direct.DirectFieldsBeanBuilder<CurrencyParameterSensitivity>

build

public CurrencyParameterSensitivity build()

marketDataName

public CurrencyParameterSensitivity.Builder marketDataName(MarketDataName<?> marketDataName)

Sets the market data name.

This name is used in the market data system to identify the data that the sensitivities refer to.

Parameters:

marketDataName - the new value, not null

Returns:

this, for chaining, not null

parameterMetadata

public CurrencyParameterSensitivity.Builder parameterMetadata(List<? extends ParameterMetadata> parameterMetadata)

Sets the list of parameter metadata.

There is one entry for each parameter.

Parameters:

parameterMetadata - the new value, not null

Returns:

this, for chaining, not null

parameterMetadata

public CurrencyParameterSensitivity.Builder parameterMetadata(ParameterMetadata... parameterMetadata)

Sets the parameterMetadata property in the builder from an array of objects.

Parameters:

parameterMetadata - the new value, not null

Returns:

this, for chaining, not null

currency

public CurrencyParameterSensitivity.Builder currency(Currency currency)

Sets the currency of the sensitivity.

Parameters:

currency - the new value, not null

Returns:

this, for chaining, not null

sensitivity

public CurrencyParameterSensitivity.Builder sensitivity(DoubleArray sensitivity)

Sets the parameter sensitivity values.

There is one sensitivity value for each parameter.

Parameters:

sensitivity - the new value, not null

Returns:

this, for chaining, not null

parameterSplit

public CurrencyParameterSensitivity.Builder parameterSplit(List<ParameterSize> parameterSplit)

Sets the split of parameters between the underlying parameterized data.

A single CurrencyParameterSensitivity represents the sensitivity to a single ParameterizedData instance. However, a ParameterizedData instance can itself be backed by more than one underlying instance. For example, a curve formed from two underlying curves. If this list is present, it represents how to split this sensitivity between the underlying instances.

Parameters:

parameterSplit - the new value

Returns:

this, for chaining, not null

parameterSplit

public CurrencyParameterSensitivity.Builder parameterSplit(ParameterSize... parameterSplit)

Sets the parameterSplit property in the builder from an array of objects.

Parameters:

parameterSplit - the new value

Returns:

this, for chaining, not null

toString

public String toString()

Overrides:

toString in class org.joda.beans.impl.direct.DirectFieldsBeanBuilder<CurrencyParameterSensitivity>