org.immutables.fixture.with.ImmutableA Maven / Gradle / Ivy
Show all versions of value-fixture Show documentation
package org.immutables.fixture.with;
import com.google.common.base.MoreObjects;
import com.google.errorprone.annotations.CanIgnoreReturnValue;
import com.google.errorprone.annotations.Var;
import java.time.Instant;
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 A}.
*
* Use the builder to create immutable instances:
* {@code ImmutableA.builder()}.
*/
@Generated(from = "A", generator = "Immutables")
@SuppressWarnings({"all"})
@ParametersAreNonnullByDefault
@javax.annotation.Generated("org.immutables.processor.ProxyProcessor")
@Immutable
@CheckReturnValue
final class ImmutableA implements A {
private final Instant lastUpdated;
private final int a;
private ImmutableA(ImmutableA.Builder builder) {
this.a = builder.a;
this.lastUpdated = builder.lastUpdated != null
? builder.lastUpdated
: Objects.requireNonNull(A.super.lastUpdated(), "lastUpdated");
}
private ImmutableA(Instant lastUpdated, int a) {
this.lastUpdated = lastUpdated;
this.a = a;
}
/**
* @return The value of the {@code lastUpdated} attribute
*/
@Override
public Instant lastUpdated() {
return lastUpdated;
}
/**
* @return The value of the {@code a} attribute
*/
@Override
public int a() {
return a;
}
/**
* Copy the current immutable object by setting a value for the {@link A#lastUpdated() lastUpdated} 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 lastUpdated
* @return A modified copy of the {@code this} object
*/
public final ImmutableA withLastUpdated(Instant value) {
if (this.lastUpdated == value) return this;
Instant newValue = Objects.requireNonNull(value, "lastUpdated");
return new ImmutableA(newValue, this.a);
}
/**
* Copy the current immutable object by setting a value for the {@link A#a() a} attribute.
* A value equality check is used to prevent copying of the same value by returning {@code this}.
* @param value A new value for a
* @return A modified copy of the {@code this} object
*/
public final ImmutableA withA(int value) {
if (this.a == value) return this;
return new ImmutableA(this.lastUpdated, value);
}
/**
* This instance is equal to all instances of {@code ImmutableA} 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 ImmutableA
&& equalTo(0, (ImmutableA) another);
}
private boolean equalTo(int synthetic, ImmutableA another) {
return lastUpdated.equals(another.lastUpdated)
&& a == another.a;
}
/**
* Computes a hash code from attributes: {@code lastUpdated}, {@code a}.
* @return hashCode value
*/
@Override
public int hashCode() {
@Var int h = 5381;
h += (h << 5) + lastUpdated.hashCode();
h += (h << 5) + a;
return h;
}
/**
* Prints the immutable value {@code A} with attribute values.
* @return A string representation of the value
*/
@Override
public String toString() {
return MoreObjects.toStringHelper("A")
.omitNullValues()
.add("lastUpdated", lastUpdated)
.add("a", a)
.toString();
}
/**
* Creates an immutable copy of a {@link A} 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 A instance
*/
public static ImmutableA copyOf(A instance) {
if (instance instanceof ImmutableA) {
return (ImmutableA) instance;
}
return ImmutableA.builder()
.from(instance)
.build();
}
/**
* Creates a builder for {@link ImmutableA ImmutableA}.
*
* ImmutableA.builder()
* .lastUpdated(java.time.Instant) // optional {@link A#lastUpdated() lastUpdated}
* .a(int) // required {@link A#a() a}
* .build();
*
* @return A new ImmutableA builder
*/
public static ImmutableA.Builder builder() {
return new ImmutableA.Builder();
}
/**
* Builds instances of type {@link ImmutableA ImmutableA}.
* 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 = "A", generator = "Immutables")
@NotThreadSafe
public static final class Builder {
private static final long INIT_BIT_A = 0x1L;
private long initBits = 0x1L;
private @Nullable Instant lastUpdated;
private int a;
private Builder() {
}
/**
* Fill a builder with attribute values from the provided {@code A} 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(A instance) {
Objects.requireNonNull(instance, "instance");
lastUpdated(instance.lastUpdated());
a(instance.a());
return this;
}
/**
* Initializes the value for the {@link A#lastUpdated() lastUpdated} attribute.
*
If not set, this attribute will have a default value as returned by the initializer of {@link A#lastUpdated() lastUpdated}.
* @param lastUpdated The value for lastUpdated
* @return {@code this} builder for use in a chained invocation
*/
@CanIgnoreReturnValue
public final Builder lastUpdated(Instant lastUpdated) {
this.lastUpdated = Objects.requireNonNull(lastUpdated, "lastUpdated");
return this;
}
/**
* Initializes the value for the {@link A#a() a} attribute.
* @param a The value for a
* @return {@code this} builder for use in a chained invocation
*/
@CanIgnoreReturnValue
public final Builder a(int a) {
this.a = a;
initBits &= ~INIT_BIT_A;
return this;
}
/**
* Builds a new {@link ImmutableA ImmutableA}.
* @return An immutable instance of A
* @throws java.lang.IllegalStateException if any required attributes are missing
*/
public ImmutableA build() {
if (initBits != 0) {
throw new IllegalStateException(formatRequiredAttributesMessage());
}
return new ImmutableA(this);
}
private String formatRequiredAttributesMessage() {
List attributes = new ArrayList<>();
if ((initBits & INIT_BIT_A) != 0) attributes.add("a");
return "Cannot build A, some of required attributes are not set " + attributes;
}
}
}