com.opengamma.strata.market.curve

Class InterpolatedNodalCurve.Builder

java.lang.Object

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

com.opengamma.strata.market.curve.InterpolatedNodalCurve.Builder

All Implemented Interfaces:

org.joda.beans.BeanBuilder<InterpolatedNodalCurve>

Enclosing class:

InterpolatedNodalCurve

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

The bean-builder for InterpolatedNodalCurve.

Method Summary

Modifier and Type	Method and Description
InterpolatedNodalCurve	build()
InterpolatedNodalCurve.Builder	extrapolatorLeft(CurveExtrapolator extrapolatorLeft) Sets the extrapolator for x-values on the left, defaulted to 'Flat".
InterpolatedNodalCurve.Builder	extrapolatorRight(CurveExtrapolator extrapolatorRight) Sets the extrapolator for x-values on the right, defaulted to 'Flat".
Object	get(String propertyName)
InterpolatedNodalCurve.Builder	interpolator(CurveInterpolator interpolator) Sets the interpolator.
InterpolatedNodalCurve.Builder	metadata(CurveMetadata metadata) Sets the curve metadata.
InterpolatedNodalCurve.Builder	set(org.joda.beans.MetaProperty<?> property, Object value)
InterpolatedNodalCurve.Builder	set(String propertyName, Object newValue)
String	toString()
InterpolatedNodalCurve.Builder	xValues(DoubleArray xValues) Sets the array of x-values, one for each point.
InterpolatedNodalCurve.Builder	yValues(DoubleArray yValues) Sets the array of y-values, one for each point.

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<InterpolatedNodalCurve>

Overrides:

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

set

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

set

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

Specified by:

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

Overrides:

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

build

public InterpolatedNodalCurve build()

metadata

public InterpolatedNodalCurve.Builder metadata(CurveMetadata metadata)

Sets the curve metadata.

The metadata includes an optional list of parameter metadata. If present, the size of the parameter metadata list will match the number of parameters of this curve.

Parameters:

metadata - the new value, not null

Returns:

this, for chaining, not null

xValues

public InterpolatedNodalCurve.Builder xValues(DoubleArray xValues)

Sets the array of x-values, one for each point.

This array will contains at least two elements and be of the same length as y-values.

Parameters:

xValues - the new value, not null

Returns:

this, for chaining, not null

yValues

public InterpolatedNodalCurve.Builder yValues(DoubleArray yValues)

Sets the array of y-values, one for each point.

This array will contains at least two elements and be of the same length as x-values.

Parameters:

yValues - the new value, not null

Returns:

this, for chaining, not null

interpolator

public InterpolatedNodalCurve.Builder interpolator(CurveInterpolator interpolator)

Sets the interpolator. This is used for x-values between the smallest and largest known x-value.

Parameters:

interpolator - the new value, not null

Returns:

this, for chaining, not null

extrapolatorLeft

public InterpolatedNodalCurve.Builder extrapolatorLeft(CurveExtrapolator extrapolatorLeft)

Sets the extrapolator for x-values on the left, defaulted to 'Flat". This is used for x-values smaller than the smallest known x-value.

Parameters:

extrapolatorLeft - the new value, not null

Returns:

this, for chaining, not null

extrapolatorRight

public InterpolatedNodalCurve.Builder extrapolatorRight(CurveExtrapolator extrapolatorRight)

Sets the extrapolator for x-values on the right, defaulted to 'Flat". This is used for x-values larger than the largest known x-value.

Parameters:

extrapolatorRight - the new value, not null

Returns:

this, for chaining, not null

toString

public String toString()

Overrides:

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