io.resys.hdes.client.api.programs.ImmutableExpressionResult Maven / Gradle / Ivy
package io.resys.hdes.client.api.programs;
import com.google.common.base.MoreObjects;
import com.google.common.collect.ImmutableList;
import com.google.errorprone.annotations.CanIgnoreReturnValue;
import com.google.errorprone.annotations.Var;
import io.resys.hdes.client.api.ast.TypeDef;
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 ExpressionProgram.ExpressionResult}.
*
* Use the builder to create immutable instances:
* {@code ImmutableExpressionResult.builder()}.
*/
@Generated(from = "ExpressionProgram.ExpressionResult", generator = "Immutables")
@SuppressWarnings({"all"})
@ParametersAreNonnullByDefault
@javax.annotation.processing.Generated("org.immutables.processor.ProxyProcessor")
@Immutable
@CheckReturnValue
public final class ImmutableExpressionResult
implements ExpressionProgram.ExpressionResult {
private final TypeDef.ValueType type;
private final ImmutableList constants;
private final @Nullable Object value;
private ImmutableExpressionResult(
TypeDef.ValueType type,
ImmutableList constants,
@Nullable Object value) {
this.type = type;
this.constants = constants;
this.value = value;
}
/**
* @return The value of the {@code type} attribute
*/
@Override
public TypeDef.ValueType getType() {
return type;
}
/**
* @return The value of the {@code constants} attribute
*/
@Override
public ImmutableList getConstants() {
return constants;
}
/**
* @return The value of the {@code value} attribute
*/
@Override
public @Nullable Object getValue() {
return value;
}
/**
* Copy the current immutable object by setting a value for the {@link ExpressionProgram.ExpressionResult#getType() type} attribute.
* A value equality check is used to prevent copying of the same value by returning {@code this}.
* @param value A new value for type
* @return A modified copy of the {@code this} object
*/
public final ImmutableExpressionResult withType(TypeDef.ValueType value) {
if (this.type == value) return this;
TypeDef.ValueType newValue = Objects.requireNonNull(value, "type");
if (this.type.equals(newValue)) return this;
return new ImmutableExpressionResult(newValue, this.constants, this.value);
}
/**
* Copy the current immutable object with elements that replace the content of {@link ExpressionProgram.ExpressionResult#getConstants() constants}.
* @param elements The elements to set
* @return A modified copy of {@code this} object
*/
public final ImmutableExpressionResult withConstants(String... elements) {
ImmutableList newValue = ImmutableList.copyOf(elements);
return new ImmutableExpressionResult(this.type, newValue, this.value);
}
/**
* Copy the current immutable object with elements that replace the content of {@link ExpressionProgram.ExpressionResult#getConstants() constants}.
* A shallow reference equality check is used to prevent copying of the same value by returning {@code this}.
* @param elements An iterable of constants elements to set
* @return A modified copy of {@code this} object
*/
public final ImmutableExpressionResult withConstants(Iterable elements) {
if (this.constants == elements) return this;
ImmutableList newValue = ImmutableList.copyOf(elements);
return new ImmutableExpressionResult(this.type, newValue, this.value);
}
/**
* Copy the current immutable object by setting a value for the {@link ExpressionProgram.ExpressionResult#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 ImmutableExpressionResult withValue(@Nullable Object value) {
if (this.value == value) return this;
return new ImmutableExpressionResult(this.type, this.constants, value);
}
/**
* This instance is equal to all instances of {@code ImmutableExpressionResult} 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 ImmutableExpressionResult
&& equalTo((ImmutableExpressionResult) another);
}
private boolean equalTo(ImmutableExpressionResult another) {
return type.equals(another.type)
&& constants.equals(another.constants)
&& Objects.equals(value, another.value);
}
/**
* Computes a hash code from attributes: {@code type}, {@code constants}, {@code value}.
* @return hashCode value
*/
@Override
public int hashCode() {
@Var int h = 5381;
h += (h << 5) + type.hashCode();
h += (h << 5) + constants.hashCode();
h += (h << 5) + Objects.hashCode(value);
return h;
}
/**
* Prints the immutable value {@code ExpressionResult} with attribute values.
* @return A string representation of the value
*/
@Override
public String toString() {
return MoreObjects.toStringHelper("ExpressionResult")
.omitNullValues()
.add("type", type)
.add("constants", constants)
.add("value", value)
.toString();
}
/**
* Creates an immutable copy of a {@link ExpressionProgram.ExpressionResult} 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 ExpressionResult instance
*/
public static ImmutableExpressionResult copyOf(ExpressionProgram.ExpressionResult instance) {
if (instance instanceof ImmutableExpressionResult) {
return (ImmutableExpressionResult) instance;
}
return ImmutableExpressionResult.builder()
.from(instance)
.build();
}
/**
* Creates a builder for {@link ImmutableExpressionResult ImmutableExpressionResult}.
*
* ImmutableExpressionResult.builder()
* .type(io.resys.hdes.client.api.ast.TypeDef.ValueType) // required {@link ExpressionProgram.ExpressionResult#getType() type}
* .addConstants|addAllConstants(String) // {@link ExpressionProgram.ExpressionResult#getConstants() constants} elements
* .value(Object | null) // nullable {@link ExpressionProgram.ExpressionResult#getValue() value}
* .build();
*
* @return A new ImmutableExpressionResult builder
*/
public static ImmutableExpressionResult.Builder builder() {
return new ImmutableExpressionResult.Builder();
}
/**
* Builds instances of type {@link ImmutableExpressionResult ImmutableExpressionResult}.
* 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 = "ExpressionProgram.ExpressionResult", generator = "Immutables")
@NotThreadSafe
public static final class Builder {
private static final long INIT_BIT_TYPE = 0x1L;
private long initBits = 0x1L;
private @Nullable TypeDef.ValueType type;
private ImmutableList.Builder constants = ImmutableList.builder();
private @Nullable Object value;
private Builder() {
}
/**
* Fill a builder with attribute values from the provided {@code ExpressionResult} instance.
* Regular attribute values will be replaced with those from the given instance.
* Absent optional values will not replace present values.
* Collection elements and entries will be added, not replaced.
* @param instance The instance from which to copy values
* @return {@code this} builder for use in a chained invocation
*/
@CanIgnoreReturnValue
public final Builder from(ExpressionProgram.ExpressionResult instance) {
Objects.requireNonNull(instance, "instance");
type(instance.getType());
addAllConstants(instance.getConstants());
@Nullable Object valueValue = instance.getValue();
if (valueValue != null) {
value(valueValue);
}
return this;
}
/**
* Initializes the value for the {@link ExpressionProgram.ExpressionResult#getType() type} attribute.
* @param type The value for type
* @return {@code this} builder for use in a chained invocation
*/
@CanIgnoreReturnValue
public final Builder type(TypeDef.ValueType type) {
this.type = Objects.requireNonNull(type, "type");
initBits &= ~INIT_BIT_TYPE;
return this;
}
/**
* Adds one element to {@link ExpressionProgram.ExpressionResult#getConstants() constants} list.
* @param element A constants element
* @return {@code this} builder for use in a chained invocation
*/
@CanIgnoreReturnValue
public final Builder addConstants(String element) {
this.constants.add(element);
return this;
}
/**
* Adds elements to {@link ExpressionProgram.ExpressionResult#getConstants() constants} list.
* @param elements An array of constants elements
* @return {@code this} builder for use in a chained invocation
*/
@CanIgnoreReturnValue
public final Builder addConstants(String... elements) {
this.constants.add(elements);
return this;
}
/**
* Sets or replaces all elements for {@link ExpressionProgram.ExpressionResult#getConstants() constants} list.
* @param elements An iterable of constants elements
* @return {@code this} builder for use in a chained invocation
*/
@CanIgnoreReturnValue
public final Builder constants(Iterable elements) {
this.constants = ImmutableList.builder();
return addAllConstants(elements);
}
/**
* Adds elements to {@link ExpressionProgram.ExpressionResult#getConstants() constants} list.
* @param elements An iterable of constants elements
* @return {@code this} builder for use in a chained invocation
*/
@CanIgnoreReturnValue
public final Builder addAllConstants(Iterable elements) {
this.constants.addAll(elements);
return this;
}
/**
* Initializes the value for the {@link ExpressionProgram.ExpressionResult#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 Object value) {
this.value = value;
return this;
}
/**
* Builds a new {@link ImmutableExpressionResult ImmutableExpressionResult}.
* @return An immutable instance of ExpressionResult
* @throws java.lang.IllegalStateException if any required attributes are missing
*/
public ImmutableExpressionResult build() {
if (initBits != 0) {
throw new IllegalStateException(formatRequiredAttributesMessage());
}
return new ImmutableExpressionResult(type, constants.build(), value);
}
private String formatRequiredAttributesMessage() {
List attributes = new ArrayList<>();
if ((initBits & INIT_BIT_TYPE) != 0) attributes.add("type");
return "Cannot build ExpressionResult, some of required attributes are not set " + attributes;
}
}
}