Package com.opengamma.strata.market.curve

Class InterpolatedNodalCurveDefinition.Builder

java.lang.Object

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

com.opengamma.strata.market.curve.InterpolatedNodalCurveDefinition.Builder

All Implemented Interfaces:

org.joda.beans.BeanBuilder<InterpolatedNodalCurveDefinition>

Enclosing class:

InterpolatedNodalCurveDefinition

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

The bean-builder for InterpolatedNodalCurveDefinition.

Method Summary

Modifier and Type	Method	Description
InterpolatedNodalCurveDefinition	build()
InterpolatedNodalCurveDefinition.Builder	dayCount(DayCount dayCount)	Sets the day count, optional.
InterpolatedNodalCurveDefinition.Builder	extrapolatorLeft(CurveExtrapolator extrapolatorLeft)	Sets the extrapolator used to find points to the left of the leftmost point on the curve.
InterpolatedNodalCurveDefinition.Builder	extrapolatorRight(CurveExtrapolator extrapolatorRight)	Sets the extrapolator used to find points to the right of the rightmost point on the curve.
Object	get(String propertyName)
InterpolatedNodalCurveDefinition.Builder	interpolator(CurveInterpolator interpolator)	Sets the interpolator used to find points on the curve.
InterpolatedNodalCurveDefinition.Builder	name(CurveName name)	Sets the curve name.
InterpolatedNodalCurveDefinition.Builder	nodes(CurveNode... nodes)	Sets the nodes property in the builder from an array of objects.
InterpolatedNodalCurveDefinition.Builder	nodes(List<? extends CurveNode> nodes)	Sets the nodes in the curve.
InterpolatedNodalCurveDefinition.Builder	set(String propertyName, Object newValue)
InterpolatedNodalCurveDefinition.Builder	set(org.joda.beans.MetaProperty<?> property, Object value)
String	toString()
InterpolatedNodalCurveDefinition.Builder	xValueType(ValueType xValueType)	Sets the x-value type, providing meaning to the x-values of the curve.
InterpolatedNodalCurveDefinition.Builder	yValueType(ValueType yValueType)	Sets the y-value type, providing meaning to the y-values of the curve.

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

Overrides:

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

set

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

set

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

Specified by:

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

Overrides:

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

build

public InterpolatedNodalCurveDefinition build()

name

public InterpolatedNodalCurveDefinition.Builder name(CurveName name)

Sets the curve name.

Parameters:

name - the new value, not null

Returns:

this, for chaining, not null

xValueType

public InterpolatedNodalCurveDefinition.Builder xValueType(ValueType xValueType)

Sets the x-value type, providing meaning to the x-values of the curve.

This type provides meaning to the x-values. For example, the x-value might represent a year fraction, as represented using ValueType.YEAR_FRACTION.

If using the builder, this defaults to ValueType.UNKNOWN.

Parameters:

xValueType - the new value, not null

Returns:

this, for chaining, not null

yValueType

public InterpolatedNodalCurveDefinition.Builder yValueType(ValueType yValueType)

Sets the y-value type, providing meaning to the y-values of the curve.

This type provides meaning to the y-values. For example, the y-value might represent a zero rate, as represented using ValueType.ZERO_RATE.

If using the builder, this defaults to ValueType.UNKNOWN.

Parameters:

yValueType - the new value, not null

Returns:

this, for chaining, not null

dayCount

public InterpolatedNodalCurveDefinition.Builder dayCount(DayCount dayCount)

Sets the day count, optional.

If the x-value of the curve represents time as a year fraction, the day count can be specified to define how the year fraction is calculated.

Parameters:

dayCount - the new value

Returns:

this, for chaining, not null

nodes

public InterpolatedNodalCurveDefinition.Builder nodes(List<? extends CurveNode> nodes)

Sets the nodes in the curve.

The nodes are used to find the par rates and calibrate the curve. There must be at least two nodes in the curve.

Parameters:

nodes - the new value, not null

Returns:

this, for chaining, not null

nodes

public InterpolatedNodalCurveDefinition.Builder nodes(CurveNode... nodes)

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

Parameters:

nodes - the new value, not null

Returns:

this, for chaining, not null

interpolator

public InterpolatedNodalCurveDefinition.Builder interpolator(CurveInterpolator interpolator)

Sets the interpolator used to find points on the curve.

Parameters:

interpolator - the new value, not null

Returns:

this, for chaining, not null

extrapolatorLeft

public InterpolatedNodalCurveDefinition.Builder extrapolatorLeft(CurveExtrapolator extrapolatorLeft)

Sets the extrapolator used to find points to the left of the leftmost point on the curve.

Parameters:

extrapolatorLeft - the new value, not null

Returns:

this, for chaining, not null

extrapolatorRight

public InterpolatedNodalCurveDefinition.Builder extrapolatorRight(CurveExtrapolator extrapolatorRight)

Sets the extrapolator used to find points to the right of the rightmost point on the curve.

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