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

Class HeuristicOptimizationAlgorithmConfig

java.lang.Object

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

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

@ParametersAreNonnullByDefault
 @Generated(value="org.immutables.processor.ProxyProcessor")
 @Immutable
 @CheckReturnValue
public final class HeuristicOptimizationAlgorithmConfig
extends AbstractHeuristicOptimizationAlgorithmConfig

Immutable implementation of AbstractHeuristicOptimizationAlgorithmConfig.

Use the builder to create immutable instances: HeuristicOptimizationAlgorithmConfig.builder(). Use the static factory method to create immutable instances: HeuristicOptimizationAlgorithmConfig.of().

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	HeuristicOptimizationAlgorithmConfig.AlgorithmBuildStage
static class	HeuristicOptimizationAlgorithmConfig.Builder Builds instances of type HeuristicOptimizationAlgorithmConfig.
static interface	HeuristicOptimizationAlgorithmConfig.BuildFinal

Nested classes/interfaces inherited from class com.dna.jopt.framework.body.scheme.helper.AbstractHeuristicOptimizationAlgorithmConfig

AbstractHeuristicOptimizationAlgorithmConfig.OptimizationAlgorithmConfig

Method Summary

Modifier and Type	Method and Description
AbstractHeuristicOptimizationAlgorithmConfig.OptimizationAlgorithmConfig	algorithm()
static HeuristicOptimizationAlgorithmConfig.AlgorithmBuildStage	builder() Creates a builder for HeuristicOptimizationAlgorithmConfig.
static HeuristicOptimizationAlgorithmConfig	copyOf(AbstractHeuristicOptimizationAlgorithmConfig instance) Creates an immutable copy of a AbstractHeuristicOptimizationAlgorithmConfig value.
boolean	equals(Object another) This instance is equal to all instances of HeuristicOptimizationAlgorithmConfig that have equal attribute values.
boolean	hasAutoFilter()
int	hashCode() Computes a hash code from attributes: algorithm, simulatedAnnealingOverrideNumIterationsValue, hasAutoFilter.
static HeuristicOptimizationAlgorithmConfig	of(AbstractHeuristicOptimizationAlgorithmConfig.OptimizationAlgorithmConfig algorithm, Optional<Integer> simulatedAnnealingOverrideNumIterationsValue) Construct a new immutable HeuristicOptimizationAlgorithmConfig instance.
Optional<Integer>	simulatedAnnealingOverrideNumIterationsValue()
String	toString() Prints the immutable value HeuristicOptimizationAlgorithmConfig with attribute values.
HeuristicOptimizationAlgorithmConfig	withAlgorithm(AbstractHeuristicOptimizationAlgorithmConfig.OptimizationAlgorithmConfig value) Copy the current immutable object by setting a value for the algorithm attribute.
HeuristicOptimizationAlgorithmConfig	withHasAutoFilter(boolean value) Copy the current immutable object by setting a value for the hasAutoFilter attribute.
HeuristicOptimizationAlgorithmConfig	withSimulatedAnnealingOverrideNumIterationsValue(int value) Copy the current immutable object by setting a present value for the optional simulatedAnnealingOverrideNumIterationsValue attribute.
HeuristicOptimizationAlgorithmConfig	withSimulatedAnnealingOverrideNumIterationsValue(Optional<Integer> optional) Copy the current immutable object by setting an optional value for the simulatedAnnealingOverrideNumIterationsValue attribute.

Methods inherited from class com.dna.jopt.framework.body.scheme.helper.AbstractHeuristicOptimizationAlgorithmConfig

convert

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

algorithm

public AbstractHeuristicOptimizationAlgorithmConfig.OptimizationAlgorithmConfig algorithm()

Specified by:

algorithm in class AbstractHeuristicOptimizationAlgorithmConfig

Returns:

The value of the algorithm attribute

simulatedAnnealingOverrideNumIterationsValue

public Optional<Integer> simulatedAnnealingOverrideNumIterationsValue()

Specified by:

simulatedAnnealingOverrideNumIterationsValue in class AbstractHeuristicOptimizationAlgorithmConfig

Returns:

The value of the simulatedAnnealingOverrideNumIterationsValue attribute

hasAutoFilter

public boolean hasAutoFilter()

Overrides:

hasAutoFilter in class AbstractHeuristicOptimizationAlgorithmConfig

Returns:

The value of the hasAutoFilter attribute

withAlgorithm

public final HeuristicOptimizationAlgorithmConfig withAlgorithm(AbstractHeuristicOptimizationAlgorithmConfig.OptimizationAlgorithmConfig value)

Copy the current immutable object by setting a value for the algorithm attribute. A value equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for algorithm

Returns:

A modified copy of the this object

withSimulatedAnnealingOverrideNumIterationsValue

public final HeuristicOptimizationAlgorithmConfig withSimulatedAnnealingOverrideNumIterationsValue(int value)

Copy the current immutable object by setting a present value for the optional simulatedAnnealingOverrideNumIterationsValue attribute.

Parameters:

value - The value for simulatedAnnealingOverrideNumIterationsValue

Returns:

A modified copy of this object

withSimulatedAnnealingOverrideNumIterationsValue

public final HeuristicOptimizationAlgorithmConfig withSimulatedAnnealingOverrideNumIterationsValue(Optional<Integer> optional)

Copy the current immutable object by setting an optional value for the simulatedAnnealingOverrideNumIterationsValue attribute. An equality check is used on inner nullable value to prevent copying of the same value by returning this.

Parameters:

optional - A value for simulatedAnnealingOverrideNumIterationsValue

Returns:

A modified copy of this object

withHasAutoFilter

public final HeuristicOptimizationAlgorithmConfig withHasAutoFilter(boolean value)

Copy the current immutable object by setting a value for the hasAutoFilter attribute. A value equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for hasAutoFilter

Returns:

A modified copy of the this object

equals

public boolean equals(@Nullable
                      Object another)

This instance is equal to all instances of HeuristicOptimizationAlgorithmConfig that have equal attribute values.

Overrides:

equals in class Object

Returns:

true if this is equal to another instance

hashCode

public int hashCode()

Computes a hash code from attributes: algorithm, simulatedAnnealingOverrideNumIterationsValue, hasAutoFilter.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value HeuristicOptimizationAlgorithmConfig with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static HeuristicOptimizationAlgorithmConfig of(AbstractHeuristicOptimizationAlgorithmConfig.OptimizationAlgorithmConfig algorithm,
                                                      Optional<Integer> simulatedAnnealingOverrideNumIterationsValue)

Construct a new immutable HeuristicOptimizationAlgorithmConfig instance.

Parameters:

algorithm - The value for the algorithm attribute

simulatedAnnealingOverrideNumIterationsValue - The value for the simulatedAnnealingOverrideNumIterationsValue attribute

Returns:

An immutable HeuristicOptimizationAlgorithmConfig instance

copyOf

public static HeuristicOptimizationAlgorithmConfig copyOf(AbstractHeuristicOptimizationAlgorithmConfig instance)

Creates an immutable copy of a AbstractHeuristicOptimizationAlgorithmConfig value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.

Parameters:

instance - The instance to copy

Returns:

A copied immutable HeuristicOptimizationAlgorithmConfig instance

builder

public static HeuristicOptimizationAlgorithmConfig.AlgorithmBuildStage builder()

Creates a builder for HeuristicOptimizationAlgorithmConfig.

 HeuristicOptimizationAlgorithmConfig.builder()
    .algorithm(com.dna.jopt.framework.body.scheme.helper.AbstractHeuristicOptimizationAlgorithmConfig.OptimizationAlgorithmConfig) // required algorithm
    .simulatedAnnealingOverrideNumIterationsValue(Integer) // optional simulatedAnnealingOverrideNumIterationsValue
    .hasAutoFilter(boolean) // optional hasAutoFilter
    .build();
 

Returns:

A new HeuristicOptimizationAlgorithmConfig builder