Package com.dna.jopt.framework.body.scheme.helper

Class HeuristicOptimizationAlgorithmConfig.Builder

java.lang.Object

com.dna.jopt.framework.body.scheme.helper.HeuristicOptimizationAlgorithmConfig.Builder

All Implemented Interfaces:

HeuristicOptimizationAlgorithmConfig.AlgorithmBuildStage, HeuristicOptimizationAlgorithmConfig.BuildFinal

Enclosing class:

HeuristicOptimizationAlgorithmConfig

@NotThreadSafe
public static final class HeuristicOptimizationAlgorithmConfig.Builder
extends Object
implements HeuristicOptimizationAlgorithmConfig.AlgorithmBuildStage, HeuristicOptimizationAlgorithmConfig.BuildFinal

Builds instances of type HeuristicOptimizationAlgorithmConfig. Initialize attributes and then invoke the build() method to create an immutable instance.

Builder is not thread-safe and generally should not be stored in a field or collection, but instead used immediately to create instances.

Method Summary

Modifier and Type	Method	Description
final HeuristicOptimizationAlgorithmConfig.Builder	algorithm(AbstractHeuristicOptimizationAlgorithmConfig.OptimizationAlgorithmConfig algorithm)	Initializes the value for the algorithm attribute.
HeuristicOptimizationAlgorithmConfig	build()	Builds a new HeuristicOptimizationAlgorithmConfig.
final HeuristicOptimizationAlgorithmConfig.Builder	hasAutoFilter(boolean hasAutoFilter)	Initializes the value for the hasAutoFilter attribute.
final HeuristicOptimizationAlgorithmConfig.Builder	simulatedAnnealingOverrideNumIterationsValue(int simulatedAnnealingOverrideNumIterationsValue)	Initializes the optional value simulatedAnnealingOverrideNumIterationsValue to simulatedAnnealingOverrideNumIterationsValue.
final HeuristicOptimizationAlgorithmConfig.Builder	simulatedAnnealingOverrideNumIterationsValue(Optional<Integer> simulatedAnnealingOverrideNumIterationsValue)	Initializes the optional value simulatedAnnealingOverrideNumIterationsValue to simulatedAnnealingOverrideNumIterationsValue.

Methods inherited from class java.lang.Object

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

Method Details

algorithm

@CanIgnoreReturnValue
public final HeuristicOptimizationAlgorithmConfig.Builder algorithm(AbstractHeuristicOptimizationAlgorithmConfig.OptimizationAlgorithmConfig algorithm)

Initializes the value for the algorithm attribute.

Specified by:

algorithm in interface HeuristicOptimizationAlgorithmConfig.AlgorithmBuildStage

Parameters:

algorithm - The value for algorithm

Returns:

this builder for use in a chained invocation

simulatedAnnealingOverrideNumIterationsValue

@CanIgnoreReturnValue
public final HeuristicOptimizationAlgorithmConfig.Builder simulatedAnnealingOverrideNumIterationsValue(int simulatedAnnealingOverrideNumIterationsValue)

Initializes the optional value simulatedAnnealingOverrideNumIterationsValue to simulatedAnnealingOverrideNumIterationsValue.

Specified by:

simulatedAnnealingOverrideNumIterationsValue in interface HeuristicOptimizationAlgorithmConfig.BuildFinal

Parameters:

simulatedAnnealingOverrideNumIterationsValue - The value for simulatedAnnealingOverrideNumIterationsValue

Returns:

this builder for chained invocation

simulatedAnnealingOverrideNumIterationsValue

@CanIgnoreReturnValue
public final HeuristicOptimizationAlgorithmConfig.Builder simulatedAnnealingOverrideNumIterationsValue(Optional<Integer> simulatedAnnealingOverrideNumIterationsValue)

Initializes the optional value simulatedAnnealingOverrideNumIterationsValue to simulatedAnnealingOverrideNumIterationsValue.

Specified by:

simulatedAnnealingOverrideNumIterationsValue in interface HeuristicOptimizationAlgorithmConfig.BuildFinal

Parameters:

simulatedAnnealingOverrideNumIterationsValue - The value for simulatedAnnealingOverrideNumIterationsValue

Returns:

this builder for use in a chained invocation

hasAutoFilter

@CanIgnoreReturnValue
public final HeuristicOptimizationAlgorithmConfig.Builder hasAutoFilter(boolean hasAutoFilter)

Initializes the value for the hasAutoFilter attribute.

If not set, this attribute will have a default value as returned by the initializer of hasAutoFilter.

Specified by:

hasAutoFilter in interface HeuristicOptimizationAlgorithmConfig.BuildFinal

Parameters:

hasAutoFilter - The value for hasAutoFilter

Returns:

this builder for use in a chained invocation

build

public HeuristicOptimizationAlgorithmConfig build()

Builds a new HeuristicOptimizationAlgorithmConfig.

Specified by:

build in interface HeuristicOptimizationAlgorithmConfig.BuildFinal

Returns:

An immutable instance of HeuristicOptimizationAlgorithmConfig

Throws:

IllegalStateException - if any required attributes are missing