io.resys.thena.docdb.sql.ImmutableSql Maven / Gradle / Ivy
package io.resys.thena.docdb.sql;
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 SqlBuilder.Sql}.
*
* Use the builder to create immutable instances:
* {@code ImmutableSql.builder()}.
*/
@Generated(from = "SqlBuilder.Sql", generator = "Immutables")
@SuppressWarnings({"all"})
@ParametersAreNonnullByDefault
@javax.annotation.processing.Generated("org.immutables.processor.ProxyProcessor")
@Immutable
@CheckReturnValue
public final class ImmutableSql implements SqlBuilder.Sql {
private final String value;
private ImmutableSql(String value) {
this.value = value;
}
/**
* @return The value of the {@code value} attribute
*/
@Override
public String getValue() {
return value;
}
/**
* Copy the current immutable object by setting a value for the {@link SqlBuilder.Sql#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
* @return A modified copy of the {@code this} object
*/
public final ImmutableSql withValue(String value) {
String newValue = Objects.requireNonNull(value, "value");
if (this.value.equals(newValue)) return this;
return new ImmutableSql(newValue);
}
/**
* This instance is equal to all instances of {@code ImmutableSql} 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 ImmutableSql
&& equalTo(0, (ImmutableSql) another);
}
private boolean equalTo(int synthetic, ImmutableSql 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 Sql} with attribute values.
* @return A string representation of the value
*/
@Override
public String toString() {
return MoreObjects.toStringHelper("Sql")
.omitNullValues()
.add("value", value)
.toString();
}
/**
* Creates an immutable copy of a {@link SqlBuilder.Sql} 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 Sql instance
*/
public static ImmutableSql copyOf(SqlBuilder.Sql instance) {
if (instance instanceof ImmutableSql) {
return (ImmutableSql) instance;
}
return ImmutableSql.builder()
.from(instance)
.build();
}
/**
* Creates a builder for {@link ImmutableSql ImmutableSql}.
*
* ImmutableSql.builder()
* .value(String) // required {@link SqlBuilder.Sql#getValue() value}
* .build();
*
* @return A new ImmutableSql builder
*/
public static ImmutableSql.Builder builder() {
return new ImmutableSql.Builder();
}
/**
* Builds instances of type {@link ImmutableSql ImmutableSql}.
* 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 = "SqlBuilder.Sql", generator = "Immutables")
@NotThreadSafe
public static final class Builder {
private static final long INIT_BIT_VALUE = 0x1L;
private long initBits = 0x1L;
private @Nullable String value;
private Builder() {
}
/**
* Fill a builder with attribute values from the provided {@code Sql} 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(SqlBuilder.Sql instance) {
Objects.requireNonNull(instance, "instance");
this.value(instance.getValue());
return this;
}
/**
* Initializes the value for the {@link SqlBuilder.Sql#getValue() value} attribute.
* @param value The value for value
* @return {@code this} builder for use in a chained invocation
*/
@CanIgnoreReturnValue
public final Builder value(String value) {
this.value = Objects.requireNonNull(value, "value");
initBits &= ~INIT_BIT_VALUE;
return this;
}
/**
* Builds a new {@link ImmutableSql ImmutableSql}.
* @return An immutable instance of Sql
* @throws java.lang.IllegalStateException if any required attributes are missing
*/
public ImmutableSql build() {
if (initBits != 0) {
throw new IllegalStateException(formatRequiredAttributesMessage());
}
return new ImmutableSql(value);
}
private String formatRequiredAttributesMessage() {
List attributes = new ArrayList<>();
if ((initBits & INIT_BIT_VALUE) != 0) attributes.add("value");
return "Cannot build Sql, some of required attributes are not set " + attributes;
}
}
}