com.opengamma.strata.market.surface

Class DeformedSurface.Builder

java.lang.Object

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

com.opengamma.strata.market.surface.DeformedSurface.Builder

All Implemented Interfaces:

org.joda.beans.BeanBuilder<DeformedSurface>

Enclosing class:

DeformedSurface

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

The bean-builder for DeformedSurface.

Method Summary

Modifier and Type	Method and Description
DeformedSurface	build()
DeformedSurface.Builder	deformationFunction(Function<DoublesPair,ValueDerivatives> deformationFunction) Sets the deformation function.
Object	get(String propertyName)
DeformedSurface.Builder	metadata(SurfaceMetadata metadata) Sets the surface metadata.
DeformedSurface.Builder	originalSurface(Surface originalSurface) Sets the original surface.
DeformedSurface.Builder	set(org.joda.beans.MetaProperty<?> property, Object value)
DeformedSurface.Builder	set(String propertyName, Object newValue)
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<DeformedSurface>

Overrides:

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

set

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

set

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

Specified by:

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

Overrides:

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

build

public DeformedSurface build()

metadata

public DeformedSurface.Builder metadata(SurfaceMetadata metadata)

Sets the surface metadata.

The metadata includes an optional list of parameter metadata.

Parameters:

metadata - the new value, not null

Returns:

this, for chaining, not null

originalSurface

public DeformedSurface.Builder originalSurface(Surface originalSurface)

Sets the original surface.

The underlying surface which receives the deformation defined by deformationFunction.

Parameters:

originalSurface - the new value, not null

Returns:

this, for chaining, not null

deformationFunction

public DeformedSurface.Builder deformationFunction(Function<DoublesPair,ValueDerivatives> deformationFunction)

Sets the deformation function.

The deformation to the original surface is define by this function. The function takes DoublesPair of x-value and y-value, then returns ValueDerivatives which contains z-value for the specified x,y values, and node sensitivities to the original surface.

Parameters:

deformationFunction - 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<DeformedSurface>