com.dna.jopt.cloud.touroptimizer.pluginservice.algorithm

Class OptimizationAlgorithmPluginResult.Builder

java.lang.Object

com.dna.jopt.cloud.touroptimizer.pluginservice.algorithm.OptimizationAlgorithmPluginResult.Builder

All Implemented Interfaces:

OptimizationAlgorithmPluginResult.BuildFinal, OptimizationAlgorithmPluginResult.StatusBuildStage

Enclosing class:

OptimizationAlgorithmPluginResult

@NotThreadSafe
public static final class OptimizationAlgorithmPluginResult.Builder
extends Object
implements OptimizationAlgorithmPluginResult.StatusBuildStage, OptimizationAlgorithmPluginResult.BuildFinal

Builds instances of type OptimizationAlgorithmPluginResult. 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 and Description
OptimizationAlgorithmPluginResult.Builder	addAllEns(Iterable<? extends IEntity> elements) Adds elements to ens list.
OptimizationAlgorithmPluginResult.Builder	addEns(IEntity... elements) Adds elements to ens list.
OptimizationAlgorithmPluginResult.Builder	addEns(IEntity element) Adds one element to ens list.
OptimizationAlgorithmPluginResult	build() Builds a new OptimizationAlgorithmPluginResult.
OptimizationAlgorithmPluginResult.Builder	status(AlgorithmPluginResultStatus status) Initializes the value for the status attribute.

Methods inherited from class java.lang.Object

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

Method Detail

addEns

@CanIgnoreReturnValue
public final OptimizationAlgorithmPluginResult.Builder addEns(IEntity element)

Adds one element to ens list.

Specified by:

addEns in interface OptimizationAlgorithmPluginResult.BuildFinal

Parameters:

element - A ens element

Returns:

this builder for use in a chained invocation

addEns

@CanIgnoreReturnValue
public final OptimizationAlgorithmPluginResult.Builder addEns(IEntity... elements)

Adds elements to ens list.

Specified by:

addEns in interface OptimizationAlgorithmPluginResult.BuildFinal

Parameters:

elements - An array of ens elements

Returns:

this builder for use in a chained invocation

addAllEns

@CanIgnoreReturnValue
public final OptimizationAlgorithmPluginResult.Builder addAllEns(Iterable<? extends IEntity> elements)

Adds elements to ens list.

Specified by:

addAllEns in interface OptimizationAlgorithmPluginResult.BuildFinal

Parameters:

elements - An iterable of ens elements

Returns:

this builder for use in a chained invocation

status

@CanIgnoreReturnValue
public final OptimizationAlgorithmPluginResult.Builder status(AlgorithmPluginResultStatus status)

Initializes the value for the status attribute.

Specified by:

status in interface OptimizationAlgorithmPluginResult.StatusBuildStage

Parameters:

status - The value for status

Returns:

this builder for use in a chained invocation

build

public OptimizationAlgorithmPluginResult build()

Builds a new OptimizationAlgorithmPluginResult.

Specified by:

build in interface OptimizationAlgorithmPluginResult.BuildFinal

Returns:

An immutable instance of OptimizationAlgorithmPluginResult

Throws:

IllegalStateException - if any required attributes are missing