io.resys.hdes.client.api.programs.ImmutableProgramContextNamedValue 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 Program.ProgramContextNamedValue}.
*
* Use the builder to create immutable instances:
* {@code ImmutableProgramContextNamedValue.builder()}.
*/
@Generated(from = "Program.ProgramContextNamedValue", generator = "Immutables")
@SuppressWarnings({"all"})
@ParametersAreNonnullByDefault
@javax.annotation.processing.Generated("org.immutables.processor.ProxyProcessor")
@Immutable
@CheckReturnValue
public final class ImmutableProgramContextNamedValue
implements Program.ProgramContextNamedValue {
private final Boolean found;
private final @Nullable Serializable value;
private ImmutableProgramContextNamedValue(Boolean found, @Nullable Serializable value) {
this.found = found;
this.value = value;
}
/**
* @return The value of the {@code found} attribute
*/
@Override
public Boolean getFound() {
return found;
}
/**
* @return The value of the {@code value} attribute
*/
@Override
public @Nullable Serializable getValue() {
return value;
}
/**
* Copy the current immutable object by setting a value for the {@link Program.ProgramContextNamedValue#getFound() found} attribute.
* An equals check used to prevent copying of the same value by returning {@code this}.
* @param value A new value for found
* @return A modified copy of the {@code this} object
*/
public final ImmutableProgramContextNamedValue withFound(Boolean value) {
Boolean newValue = Objects.requireNonNull(value, "found");
if (this.found.equals(newValue)) return this;
return new ImmutableProgramContextNamedValue(newValue, this.value);
}
/**
* Copy the current immutable object by setting a value for the {@link Program.ProgramContextNamedValue#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 (can be {@code null})
* @return A modified copy of the {@code this} object
*/
public final ImmutableProgramContextNamedValue withValue(@Nullable Serializable value) {
if (this.value == value) return this;
return new ImmutableProgramContextNamedValue(this.found, value);
}
/**
* This instance is equal to all instances of {@code ImmutableProgramContextNamedValue} 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 ImmutableProgramContextNamedValue
&& equalTo((ImmutableProgramContextNamedValue) another);
}
private boolean equalTo(ImmutableProgramContextNamedValue another) {
return found.equals(another.found)
&& Objects.equals(value, another.value);
}
/**
* Computes a hash code from attributes: {@code found}, {@code value}.
* @return hashCode value
*/
@Override
public int hashCode() {
@Var int h = 5381;
h += (h << 5) + found.hashCode();
h += (h << 5) + Objects.hashCode(value);
return h;
}
/**
* Prints the immutable value {@code ProgramContextNamedValue} with attribute values.
* @return A string representation of the value
*/
@Override
public String toString() {
return MoreObjects.toStringHelper("ProgramContextNamedValue")
.omitNullValues()
.add("found", found)
.add("value", value)
.toString();
}
/**
* Creates an immutable copy of a {@link Program.ProgramContextNamedValue} 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 ProgramContextNamedValue instance
*/
public static ImmutableProgramContextNamedValue copyOf(Program.ProgramContextNamedValue instance) {
if (instance instanceof ImmutableProgramContextNamedValue) {
return (ImmutableProgramContextNamedValue) instance;
}
return ImmutableProgramContextNamedValue.builder()
.from(instance)
.build();
}
/**
* Creates a builder for {@link ImmutableProgramContextNamedValue ImmutableProgramContextNamedValue}.
*
* ImmutableProgramContextNamedValue.builder()
* .found(Boolean) // required {@link Program.ProgramContextNamedValue#getFound() found}
* .value(java.io.Serializable | null) // nullable {@link Program.ProgramContextNamedValue#getValue() value}
* .build();
*
* @return A new ImmutableProgramContextNamedValue builder
*/
public static ImmutableProgramContextNamedValue.Builder builder() {
return new ImmutableProgramContextNamedValue.Builder();
}
/**
* Builds instances of type {@link ImmutableProgramContextNamedValue ImmutableProgramContextNamedValue}.
* 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 = "Program.ProgramContextNamedValue", generator = "Immutables")
@NotThreadSafe
public static final class Builder {
private static final long INIT_BIT_FOUND = 0x1L;
private long initBits = 0x1L;
private @Nullable Boolean found;
private @Nullable Serializable value;
private Builder() {
}
/**
* Fill a builder with attribute values from the provided {@code ProgramContextNamedValue} 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(Program.ProgramContextNamedValue instance) {
Objects.requireNonNull(instance, "instance");
found(instance.getFound());
@Nullable Serializable valueValue = instance.getValue();
if (valueValue != null) {
value(valueValue);
}
return this;
}
/**
* Initializes the value for the {@link Program.ProgramContextNamedValue#getFound() found} attribute.
* @param found The value for found
* @return {@code this} builder for use in a chained invocation
*/
@CanIgnoreReturnValue
public final Builder found(Boolean found) {
this.found = Objects.requireNonNull(found, "found");
initBits &= ~INIT_BIT_FOUND;
return this;
}
/**
* Initializes the value for the {@link Program.ProgramContextNamedValue#getValue() value} attribute.
* @param value The value for value (can be {@code null})
* @return {@code this} builder for use in a chained invocation
*/
@CanIgnoreReturnValue
public final Builder value(@Nullable Serializable value) {
this.value = value;
return this;
}
/**
* Builds a new {@link ImmutableProgramContextNamedValue ImmutableProgramContextNamedValue}.
* @return An immutable instance of ProgramContextNamedValue
* @throws java.lang.IllegalStateException if any required attributes are missing
*/
public ImmutableProgramContextNamedValue build() {
if (initBits != 0) {
throw new IllegalStateException(formatRequiredAttributesMessage());
}
return new ImmutableProgramContextNamedValue(found, value);
}
private String formatRequiredAttributesMessage() {
List attributes = new ArrayList<>();
if ((initBits & INIT_BIT_FOUND) != 0) attributes.add("found");
return "Cannot build ProgramContextNamedValue, some of required attributes are not set " + attributes;
}
}
}