io.resys.wrench.assets.flow.api.model.ImmutableFlowCommand Maven / Gradle / Ivy
package io.resys.wrench.assets.flow.api.model;
import com.google.common.base.MoreObjects;
import com.google.errorprone.annotations.CanIgnoreReturnValue;
import com.google.errorprone.annotations.Var;
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 FlowAst.FlowCommand}.
*
* Use the builder to create immutable instances:
* {@code ImmutableFlowCommand.builder()}.
*/
@Generated(from = "FlowAst.FlowCommand", generator = "Immutables")
@SuppressWarnings({"all"})
@ParametersAreNonnullByDefault
@javax.annotation.processing.Generated("org.immutables.processor.ProxyProcessor")
@Immutable
@CheckReturnValue
public final class ImmutableFlowCommand implements FlowAst.FlowCommand {
private final int id;
private final @Nullable String value;
private final FlowAst.FlowCommandType type;
private ImmutableFlowCommand(
int id,
@Nullable String value,
FlowAst.FlowCommandType type) {
this.id = id;
this.value = value;
this.type = type;
}
/**
* @return The value of the {@code id} attribute
*/
@Override
public int getId() {
return id;
}
/**
* @return The value of the {@code value} attribute
*/
@Override
public @Nullable String getValue() {
return value;
}
/**
* @return The value of the {@code type} attribute
*/
@Override
public FlowAst.FlowCommandType getType() {
return type;
}
/**
* Copy the current immutable object by setting a value for the {@link FlowAst.FlowCommand#getId() id} attribute.
* A value equality check is used to prevent copying of the same value by returning {@code this}.
* @param value A new value for id
* @return A modified copy of the {@code this} object
*/
public final ImmutableFlowCommand withId(int value) {
if (this.id == value) return this;
return new ImmutableFlowCommand(value, this.value, this.type);
}
/**
* Copy the current immutable object by setting a value for the {@link FlowAst.FlowCommand#getValue() value} attribute.
* An equals check 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 ImmutableFlowCommand withValue(@Nullable String value) {
if (Objects.equals(this.value, value)) return this;
return new ImmutableFlowCommand(this.id, value, this.type);
}
/**
* Copy the current immutable object by setting a value for the {@link FlowAst.FlowCommand#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 ImmutableFlowCommand withType(FlowAst.FlowCommandType value) {
if (this.type == value) return this;
FlowAst.FlowCommandType newValue = Objects.requireNonNull(value, "type");
if (this.type.equals(newValue)) return this;
return new ImmutableFlowCommand(this.id, this.value, newValue);
}
/**
* This instance is equal to all instances of {@code ImmutableFlowCommand} 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 ImmutableFlowCommand
&& equalTo((ImmutableFlowCommand) another);
}
private boolean equalTo(ImmutableFlowCommand another) {
return id == another.id
&& Objects.equals(value, another.value)
&& type.equals(another.type);
}
/**
* Computes a hash code from attributes: {@code id}, {@code value}, {@code type}.
* @return hashCode value
*/
@Override
public int hashCode() {
@Var int h = 5381;
h += (h << 5) + id;
h += (h << 5) + Objects.hashCode(value);
h += (h << 5) + type.hashCode();
return h;
}
/**
* Prints the immutable value {@code FlowCommand} with attribute values.
* @return A string representation of the value
*/
@Override
public String toString() {
return MoreObjects.toStringHelper("FlowCommand")
.omitNullValues()
.add("id", id)
.add("value", value)
.add("type", type)
.toString();
}
/**
* Creates an immutable copy of a {@link FlowAst.FlowCommand} 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 FlowCommand instance
*/
public static ImmutableFlowCommand copyOf(FlowAst.FlowCommand instance) {
if (instance instanceof ImmutableFlowCommand) {
return (ImmutableFlowCommand) instance;
}
return ImmutableFlowCommand.builder()
.from(instance)
.build();
}
/**
* Creates a builder for {@link ImmutableFlowCommand ImmutableFlowCommand}.
*
* ImmutableFlowCommand.builder()
* .id(int) // required {@link FlowAst.FlowCommand#getId() id}
* .value(String | null) // nullable {@link FlowAst.FlowCommand#getValue() value}
* .type(io.resys.wrench.assets.flow.api.model.FlowAst.FlowCommandType) // required {@link FlowAst.FlowCommand#getType() type}
* .build();
*
* @return A new ImmutableFlowCommand builder
*/
public static ImmutableFlowCommand.Builder builder() {
return new ImmutableFlowCommand.Builder();
}
/**
* Builds instances of type {@link ImmutableFlowCommand ImmutableFlowCommand}.
* 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 = "FlowAst.FlowCommand", generator = "Immutables")
@NotThreadSafe
public static final class Builder {
private static final long INIT_BIT_ID = 0x1L;
private static final long INIT_BIT_TYPE = 0x2L;
private long initBits = 0x3L;
private int id;
private @Nullable String value;
private @Nullable FlowAst.FlowCommandType type;
private Builder() {
}
/**
* Fill a builder with attribute values from the provided {@code FlowCommand} 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(FlowAst.FlowCommand instance) {
Objects.requireNonNull(instance, "instance");
id(instance.getId());
@Nullable String valueValue = instance.getValue();
if (valueValue != null) {
value(valueValue);
}
type(instance.getType());
return this;
}
/**
* Initializes the value for the {@link FlowAst.FlowCommand#getId() id} attribute.
* @param id The value for id
* @return {@code this} builder for use in a chained invocation
*/
@CanIgnoreReturnValue
public final Builder id(int id) {
this.id = id;
initBits &= ~INIT_BIT_ID;
return this;
}
/**
* Initializes the value for the {@link FlowAst.FlowCommand#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 String value) {
this.value = value;
return this;
}
/**
* Initializes the value for the {@link FlowAst.FlowCommand#getType() type} attribute.
* @param type The value for type
* @return {@code this} builder for use in a chained invocation
*/
@CanIgnoreReturnValue
public final Builder type(FlowAst.FlowCommandType type) {
this.type = Objects.requireNonNull(type, "type");
initBits &= ~INIT_BIT_TYPE;
return this;
}
/**
* Builds a new {@link ImmutableFlowCommand ImmutableFlowCommand}.
* @return An immutable instance of FlowCommand
* @throws java.lang.IllegalStateException if any required attributes are missing
*/
public ImmutableFlowCommand build() {
if (initBits != 0) {
throw new IllegalStateException(formatRequiredAttributesMessage());
}
return new ImmutableFlowCommand(id, value, type);
}
private String formatRequiredAttributesMessage() {
List attributes = new ArrayList<>();
if ((initBits & INIT_BIT_ID) != 0) attributes.add("id");
if ((initBits & INIT_BIT_TYPE) != 0) attributes.add("type");
return "Cannot build FlowCommand, some of required attributes are not set " + attributes;
}
}
}