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