com.opengamma.strata.market.param

Class PointShiftsBuilder

java.lang.Object

com.opengamma.strata.market.param.PointShiftsBuilder

public final class PointShiftsBuilder
extends Object

Mutable builder for building instances of PointShifts.

This is created via PointShifts.builder(ShiftType).

Method Summary

Modifier and Type	Method and Description
PointShiftsBuilder	addShift(int scenarioIndex, Object nodeIdentifier, double shiftAmount) Adds a shift for a parameter to the builder.
PointShiftsBuilder	addShifts(int scenarioIndex, Map<?,Double> shiftMap) Adds multiple shifts to the builder.
PointShifts	build() Returns an instance of PointShifts built from the data in this builder.

Methods inherited from class java.lang.Object

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

Method Detail

addShift

public PointShiftsBuilder addShift(int scenarioIndex,
                                   Object nodeIdentifier,
                                   double shiftAmount)

Adds a shift for a parameter to the builder.

Parameters:

scenarioIndex - the index of the scenario containing the shift

nodeIdentifier - the identifier of the node to which the shift should be applied

shiftAmount - the size of the shift

Returns:

this builder

addShifts

public PointShiftsBuilder addShifts(int scenarioIndex,
                                    Map<?,Double> shiftMap)

Adds multiple shifts to the builder.

Parameters:

scenarioIndex - the index of the scenario containing the shifts

shiftMap - the shift amounts, keyed by the identifier of the node to which they should be applied

Returns:

this builder

build

public PointShifts build()

Returns an instance of PointShifts built from the data in this builder.

Returns:

an instance of PointShifts built from the data in this builder