SeasonalCurve.Builder (finmath lib 5.0.2 API)

java.lang.Object
- net.finmath.marketdata.model.curves.CurveInterpolation.Builder
- - net.finmath.marketdata.model.curves.SeasonalCurve.Builder

All Implemented Interfaces:

CurveBuilder

Enclosing class:

SeasonalCurve
```
public static class SeasonalCurve.Builder
extends CurveInterpolation.Builder
implements CurveBuilder
```
A builder (following the builder pattern) for SeasonalCurve objects. Allows to successively construct a curve object by adding points to its base points.

Author:

Christian Fries

- Constructor Summary
  
  Constructors
  Constructor Description
  
  Builder(SeasonalCurve seasonalCurve)
  Create a CurveBuilder from a given seasonalCurve.
- Method Summary
  
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method Description
  
  Curve build()
  Build the curve.
  - Methods inherited from class net.finmath.marketdata.model.curves.CurveInterpolation.Builder
    addPoint, setExtrapolationMethod, setInterpolationEntity, setInterpolationMethod
  - Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  - Methods inherited from interface net.finmath.marketdata.model.curves.CurveBuilder
    addPoint

- Constructor Detail
  - Builder
```
public Builder(SeasonalCurve seasonalCurve)
        throws CloneNotSupportedException
```
    Create a CurveBuilder from a given seasonalCurve.
    
    Parameters:
    
    seasonalCurve - The seasonal curve from which to copy the fixed part upon build().
    
    Throws:
    
    CloneNotSupportedException - Thrown, when the base curve could not be cloned.
- Method Detail
  - build
```
public Curve build()
            throws CloneNotSupportedException
```
    Description copied from interface: CurveBuilder
    
    Build the curve. The method returns the curve object. The builder cannot be used to build another curve. Use clone instead.
    
    Specified by:
    
    build in interface CurveBuilder
    
    Overrides:
    
    build in class CurveInterpolation.Builder
    
    Returns:
    
    The curve according to the specification.
    
    Throws:
    
    CloneNotSupportedException - Thrown if the curve could not be build (likely due to a template throwing CloneNotSupportedException.