io.resys.hdes.client.api.programs.ImmutableServiceResult Maven / Gradle / Ivy
package io.resys.hdes.client.api.programs;
import com.google.common.base.MoreObjects;
import com.google.errorprone.annotations.CanIgnoreReturnValue;
import com.google.errorprone.annotations.Var;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;
import java.util.Objects;
import javax.annotation.CheckReturnValue;
import javax.annotation.Nullable;
import javax.annotation.ParametersAreNonnullByDefault;
import javax.annotation.concurrent.Immutable;
import javax.annotation.concurrent.NotThreadSafe;
import org.immutables.value.Generated;
/**
* Immutable implementation of {@link ServiceProgram.ServiceResult}.
*
* Use the builder to create immutable instances:
* {@code ImmutableServiceResult.builder()}.
*/
@Generated(from = "ServiceProgram.ServiceResult", generator = "Immutables")
@SuppressWarnings({"all"})
@ParametersAreNonnullByDefault
@javax.annotation.processing.Generated("org.immutables.processor.ProxyProcessor")
@Immutable
@CheckReturnValue
public final class ImmutableServiceResult
implements ServiceProgram.ServiceResult {
private final Serializable value;
private ImmutableServiceResult(Serializable value) {
this.value = value;
}
/**
* @return The value of the {@code value} attribute
*/
@Override
public Serializable getValue() {
return value;
}
/**
* Copy the current immutable object by setting a value for the {@link ServiceProgram.ServiceResult#getValue() value} attribute.
* A shallow reference equality check is used to prevent copying of the same value by returning {@code this}.
* @param value A new value for value
* @return A modified copy of the {@code this} object
*/
public final ImmutableServiceResult withValue(Serializable value) {
if (this.value == value) return this;
Serializable newValue = Objects.requireNonNull(value, "value");
return new ImmutableServiceResult(newValue);
}
/**
* This instance is equal to all instances of {@code ImmutableServiceResult} that have equal attribute values.
* @return {@code true} if {@code this} is equal to {@code another} instance
*/
@Override
public boolean equals(@Nullable Object another) {
if (this == another) return true;
return another instanceof ImmutableServiceResult
&& equalTo((ImmutableServiceResult) another);
}
private boolean equalTo(ImmutableServiceResult another) {
return value.equals(another.value);
}
/**
* Computes a hash code from attributes: {@code value}.
* @return hashCode value
*/
@Override
public int hashCode() {
@Var int h = 5381;
h += (h << 5) + value.hashCode();
return h;
}
/**
* Prints the immutable value {@code ServiceResult} with attribute values.
* @return A string representation of the value
*/
@Override
public String toString() {
return MoreObjects.toStringHelper("ServiceResult")
.omitNullValues()
.add("value", value)
.toString();
}
/**
* Creates an immutable copy of a {@link ServiceProgram.ServiceResult} value.
* Uses accessors to get values to initialize the new immutable instance.
* If an instance is already immutable, it is returned as is.
* @param instance The instance to copy
* @return A copied immutable ServiceResult instance
*/
public static ImmutableServiceResult copyOf(ServiceProgram.ServiceResult instance) {
if (instance instanceof ImmutableServiceResult) {
return (ImmutableServiceResult) instance;
}
return ImmutableServiceResult.builder()
.from(instance)
.build();
}
/**
* Creates a builder for {@link ImmutableServiceResult ImmutableServiceResult}.
*
* ImmutableServiceResult.builder()
* .value(java.io.Serializable) // required {@link ServiceProgram.ServiceResult#getValue() value}
* .build();
*
* @return A new ImmutableServiceResult builder
*/
public static ImmutableServiceResult.Builder builder() {
return new ImmutableServiceResult.Builder();
}
/**
* Builds instances of type {@link ImmutableServiceResult ImmutableServiceResult}.
* Initialize attributes and then invoke the {@link #build()} method to create an
* immutable instance.
* {@code Builder} is not thread-safe and generally should not be stored in a field or collection,
* but instead used immediately to create instances.
*/
@Generated(from = "ServiceProgram.ServiceResult", generator = "Immutables")
@NotThreadSafe
public static final class Builder {
private static final long INIT_BIT_VALUE = 0x1L;
private long initBits = 0x1L;
private @Nullable Serializable value;
private Builder() {
}
/**
* Fill a builder with attribute values from the provided {@code ServiceResult} instance.
* Regular attribute values will be replaced with those from the given instance.
* Absent optional values will not replace present values.
* @param instance The instance from which to copy values
* @return {@code this} builder for use in a chained invocation
*/
@CanIgnoreReturnValue
public final Builder from(ServiceProgram.ServiceResult instance) {
Objects.requireNonNull(instance, "instance");
value(instance.getValue());
return this;
}
/**
* Initializes the value for the {@link ServiceProgram.ServiceResult#getValue() value} attribute.
* @param value The value for value
* @return {@code this} builder for use in a chained invocation
*/
@CanIgnoreReturnValue
public final Builder value(Serializable value) {
this.value = Objects.requireNonNull(value, "value");
initBits &= ~INIT_BIT_VALUE;
return this;
}
/**
* Builds a new {@link ImmutableServiceResult ImmutableServiceResult}.
* @return An immutable instance of ServiceResult
* @throws java.lang.IllegalStateException if any required attributes are missing
*/
public ImmutableServiceResult build() {
if (initBits != 0) {
throw new IllegalStateException(formatRequiredAttributesMessage());
}
return new ImmutableServiceResult(value);
}
private String formatRequiredAttributesMessage() {
List attributes = new ArrayList<>();
if ((initBits & INIT_BIT_VALUE) != 0) attributes.add("value");
return "Cannot build ServiceResult, some of required attributes are not set " + attributes;
}
}
}