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

Class AlgorithmPluginResultStatus

java.lang.Object

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

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

@ParametersAreNonnullByDefault
@Generated("org.immutables.processor.ProxyProcessor")
@Immutable
@CheckReturnValue
public final class AlgorithmPluginResultStatus
extends AbstractAlgorithmPluginResultStatus

Immutable implementation of AbstractAlgorithmPluginResultStatus.

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

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class com.dna.jopt.cloud.touroptimizer.pluginservice.algorithm.AbstractAlgorithmPluginResultStatus

AbstractAlgorithmPluginResultStatus.AlgorithmPluginResultStatusTag

Method Summary

Modifier and Type	Method	Description
static AlgorithmPluginResultStatus.StatusBuildStage	builder()	Creates a builder for AlgorithmPluginResultStatus.
static AlgorithmPluginResultStatus	copyOf(AbstractAlgorithmPluginResultStatus instance)	Creates an immutable copy of a AbstractAlgorithmPluginResultStatus value.
boolean	equals(Object another)	This instance is equal to all instances of AlgorithmPluginResultStatus that have equal attribute values.
int	hashCode()	Computes a hash code from attributes: statusDescription, status.
static AlgorithmPluginResultStatus	of(Optional<String> statusDescription, AbstractAlgorithmPluginResultStatus.AlgorithmPluginResultStatusTag status)	Construct a new immutable AlgorithmPluginResultStatus instance.
AbstractAlgorithmPluginResultStatus.AlgorithmPluginResultStatusTag	status()
Optional<String>	statusDescription()
String	toString()	Prints the immutable value AlgorithmPluginResultStatus with attribute values.
final AlgorithmPluginResultStatus	withStatus(AbstractAlgorithmPluginResultStatus.AlgorithmPluginResultStatusTag value)	Copy the current immutable object by setting a value for the status attribute.
final AlgorithmPluginResultStatus	withStatusDescription(String value)	Copy the current immutable object by setting a present value for the optional statusDescription attribute.
final AlgorithmPluginResultStatus	withStatusDescription(Optional<String> optional)	Copy the current immutable object by setting an optional value for the statusDescription attribute.

Methods inherited from class com.dna.jopt.cloud.touroptimizer.pluginservice.algorithm.AbstractAlgorithmPluginResultStatus

defaultErrorResult, defaultSuccessResult, result

Methods inherited from class java.lang.Object

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

Method Details

statusDescription

public Optional<String> statusDescription()

Specified by:

statusDescription in class AbstractAlgorithmPluginResultStatus

Returns:

The value of the statusDescription attribute

status

public AbstractAlgorithmPluginResultStatus.AlgorithmPluginResultStatusTag status()

Specified by:

status in class AbstractAlgorithmPluginResultStatus

Returns:

The value of the status attribute

withStatusDescription

public final AlgorithmPluginResultStatus withStatusDescription(String value)

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

Parameters:

value - The value for statusDescription

Returns:

A modified copy of this object

withStatusDescription

public final AlgorithmPluginResultStatus withStatusDescription(Optional<String> optional)

Copy the current immutable object by setting an optional value for the statusDescription 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 statusDescription

Returns:

A modified copy of this object

withStatus

public final AlgorithmPluginResultStatus withStatus(AbstractAlgorithmPluginResultStatus.AlgorithmPluginResultStatusTag value)

Copy the current immutable object by setting a value for the status attribute. A value 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 AlgorithmPluginResultStatus 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: statusDescription, status.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value AlgorithmPluginResultStatus with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static AlgorithmPluginResultStatus of(Optional<String> statusDescription,
 AbstractAlgorithmPluginResultStatus.AlgorithmPluginResultStatusTag status)

Construct a new immutable AlgorithmPluginResultStatus instance.

Parameters:

statusDescription - The value for the statusDescription attribute

status - The value for the status attribute

Returns:

An immutable AlgorithmPluginResultStatus instance

copyOf

public static AlgorithmPluginResultStatus copyOf(AbstractAlgorithmPluginResultStatus instance)

Creates an immutable copy of a AbstractAlgorithmPluginResultStatus 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 AlgorithmPluginResultStatus instance

builder

public static AlgorithmPluginResultStatus.StatusBuildStage builder()

Creates a builder for AlgorithmPluginResultStatus.

 AlgorithmPluginResultStatus.builder()
    .statusDescription(String) // optional statusDescription
    .status(com.dna.jopt.cloud.touroptimizer.pluginservice.algorithm.AbstractAlgorithmPluginResultStatus.AlgorithmPluginResultStatusTag) // required status
    .build();
 

Returns:

A new AlgorithmPluginResultStatus builder