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

Class OptimizationAlgorithmPluginResult

java.lang.Object

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

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

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

Immutable implementation of AbstractOptimizationAlgorithmPluginResult.

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OptimizationAlgorithmPluginResult.Builder Builds instances of type OptimizationAlgorithmPluginResult.
static interface	OptimizationAlgorithmPluginResult.BuildFinal
static interface	OptimizationAlgorithmPluginResult.StatusBuildStage

Method Summary

Modifier and Type	Method and Description
static OptimizationAlgorithmPluginResult.StatusBuildStage	builder() Creates a builder for OptimizationAlgorithmPluginResult.
static OptimizationAlgorithmPluginResult	copyOf(AbstractOptimizationAlgorithmPluginResult instance) Creates an immutable copy of a AbstractOptimizationAlgorithmPluginResult value.
com.google.common.collect.ImmutableList<IEntity>	ens()
boolean	equals(Object another) This instance is equal to all instances of OptimizationAlgorithmPluginResult that have equal attribute values.
int	hashCode() Computes a hash code from attributes: ens, status.
static OptimizationAlgorithmPluginResult	of(Iterable<? extends IEntity> ens, AlgorithmPluginResultStatus status) Construct a new immutable OptimizationAlgorithmPluginResult instance.
static OptimizationAlgorithmPluginResult	of(List<IEntity> ens, AlgorithmPluginResultStatus status) Construct a new immutable OptimizationAlgorithmPluginResult instance.
AlgorithmPluginResultStatus	status()
String	toString() Prints the immutable value OptimizationAlgorithmPluginResult with attribute values.
OptimizationAlgorithmPluginResult	withEns(IEntity... elements) Copy the current immutable object with elements that replace the content of ens.
OptimizationAlgorithmPluginResult	withEns(Iterable<? extends IEntity> elements) Copy the current immutable object with elements that replace the content of ens.
OptimizationAlgorithmPluginResult	withStatus(AlgorithmPluginResultStatus value) Copy the current immutable object by setting a value for the status attribute.

Methods inherited from class java.lang.Object

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

Method Detail

ens

public com.google.common.collect.ImmutableList<IEntity> ens()

Specified by:

ens in class AbstractOptimizationAlgorithmPluginResult

Returns:

The value of the ens attribute

status

public AlgorithmPluginResultStatus status()

Specified by:

status in class AbstractOptimizationAlgorithmPluginResult

Returns:

The value of the status attribute

withEns

public final OptimizationAlgorithmPluginResult withEns(IEntity... elements)

Copy the current immutable object with elements that replace the content of ens.

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withEns

public final OptimizationAlgorithmPluginResult withEns(Iterable<? extends IEntity> elements)

Copy the current immutable object with elements that replace the content of ens. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

elements - An iterable of ens elements to set

Returns:

A modified copy of this object

withStatus

public final OptimizationAlgorithmPluginResult withStatus(AlgorithmPluginResultStatus value)

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

Parameters:

value - A new value for status

Returns:

A modified copy of the this object

equals

public boolean equals(@Nullable
                      Object another)

This instance is equal to all instances of OptimizationAlgorithmPluginResult 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: ens, status.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value OptimizationAlgorithmPluginResult with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static OptimizationAlgorithmPluginResult of(List<IEntity> ens,
                                                   AlgorithmPluginResultStatus status)

Construct a new immutable OptimizationAlgorithmPluginResult instance.

Parameters:

ens - The value for the ens attribute

status - The value for the status attribute

Returns:

An immutable OptimizationAlgorithmPluginResult instance

of

public static OptimizationAlgorithmPluginResult of(Iterable<? extends IEntity> ens,
                                                   AlgorithmPluginResultStatus status)

Construct a new immutable OptimizationAlgorithmPluginResult instance.

Parameters:

ens - The value for the ens attribute

status - The value for the status attribute

Returns:

An immutable OptimizationAlgorithmPluginResult instance

copyOf

public static OptimizationAlgorithmPluginResult copyOf(AbstractOptimizationAlgorithmPluginResult instance)

Creates an immutable copy of a AbstractOptimizationAlgorithmPluginResult 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 OptimizationAlgorithmPluginResult instance

builder

public static OptimizationAlgorithmPluginResult.StatusBuildStage builder()

Creates a builder for OptimizationAlgorithmPluginResult.

 OptimizationAlgorithmPluginResult.builder()
    .addEns|addAllEns(com.dna.jopt.member.bucket.entity.IEntity) // ens elements
    .status(com.dna.jopt.cloud.touroptimizer.pluginservice.algorithm.AlgorithmPluginResultStatus) // required status
    .build();
 

Returns:

A new OptimizationAlgorithmPluginResult builder