org.immutables.fixture.ImmutableInternCustomHashCode Maven / Gradle / Ivy

Go to download
package org.immutables.fixture;

import com.google.common.base.MoreObjects;
import com.google.common.base.Preconditions;
import com.google.common.collect.Interner;
import com.google.common.collect.Interners;
import com.google.common.collect.Lists;
import java.util.List;
import javax.annotation.Generated;
import javax.annotation.Nullable;
import javax.annotation.ParametersAreNonnullByDefault;
import javax.annotation.concurrent.Immutable;
import javax.annotation.concurrent.NotThreadSafe;

/**
 * Immutable implementation of {@link AbstractToStringHashCode.InternCustomHashCode}.
 * 
 * Use the builder to create immutable instances:
 * {@code ImmutableInternCustomHashCode.builder()}.
 */
@SuppressWarnings("all")
@ParametersAreNonnullByDefault
@Generated({"Immutables.generator", "AbstractToStringHashCode.InternCustomHashCode"})
@Immutable
final class ImmutableInternCustomHashCode
    extends AbstractToStringHashCode.InternCustomHashCode {
  private final int a;

  private ImmutableInternCustomHashCode(int a) {
    this.a = a;
  }

  /**
   * @return The value of the {@code a} attribute
   */
  @Override
  int a() {
    return a;
  }

  /**
   * Copy the current immutable object by setting a value for the {@link AbstractToStringHashCode.InternCustomHashCode#a() a} attribute.
   * A value equality check is used to prevent copying of the same value by returning {@code this}.
   * @param a A new value for a
   * @return A modified copy of the {@code this} object
   */
  public final ImmutableInternCustomHashCode withA(int a) {
    if (this.a == a) return this;
    return validate(new ImmutableInternCustomHashCode(a));
  }

  /**
   * This instance is equal to all instances of {@code ImmutableInternCustomHashCode} that have equal attribute values.
   * As instances of the {@code ImmutableInternCustomHashCode} class are interned, the {@code equals} method is implemented
   * as an efficient reference equality check.
   * @return {@code true} if {@code this} is equal to {@code another} instance
   */
  @Override
  public boolean equals(@Nullable Object another) {
    return this == another;
  }

  private boolean equalTo(ImmutableInternCustomHashCode another) {
    return super.equals(another);
  }

  /**
   * Prints the immutable value {@code InternCustomHashCode} with attribute values.
   * @return A string representation of the value
   */
  @Override
  public String toString() {
    return MoreObjects.toStringHelper("InternCustomHashCode")
        .omitNullValues()
        .add("a", a)
        .toString();
  }

  private static class InternProxy {
    final ImmutableInternCustomHashCode instance;

    InternProxy(ImmutableInternCustomHashCode instance) {
      this.instance = instance;
    }

    @Override
    public boolean equals(@Nullable Object another) {
      return instance.equalTo(((InternProxy) another).instance);
    }

    @Override
    public int hashCode() {
      return instance.hashCode();
    }
  }

  private static final Interner INTERNER = Interners.newStrongInterner();

  private static ImmutableInternCustomHashCode validate(ImmutableInternCustomHashCode instance) {
    return INTERNER.intern(new InternProxy(instance)).instance;
  }

  /**
   * Creates an immutable copy of a {@link AbstractToStringHashCode.InternCustomHashCode} 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 InternCustomHashCode instance
   */
  public static ImmutableInternCustomHashCode copyOf(AbstractToStringHashCode.InternCustomHashCode instance) {
    if (instance instanceof ImmutableInternCustomHashCode) {
      return (ImmutableInternCustomHashCode) instance;
    }
    return ImmutableInternCustomHashCode.builder()
        .from(instance)
        .build();
  }

  /**
   * Creates a builder for {@link ImmutableInternCustomHashCode ImmutableInternCustomHashCode}.
   * @return A new ImmutableInternCustomHashCode builder
   */
  public static ImmutableInternCustomHashCode.Builder builder() {
    return new ImmutableInternCustomHashCode.Builder();
  }

  /**
   * Builds instances of type {@link ImmutableInternCustomHashCode ImmutableInternCustomHashCode}.
   * 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.
   */
  @NotThreadSafe
  static final class Builder {
    private static final long INIT_BIT_A = 0x1L;
    private long initBits = 0x1L;

    private int a;

    private Builder() {
    }

    /**
     * Fill a builder with attribute values from the provided {@code InternCustomHashCode} 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
     */
    public final Builder from(AbstractToStringHashCode.InternCustomHashCode instance) {
      Preconditions.checkNotNull(instance, "instance");
      a(instance.a());
      return this;
    }

    /**
     * Initializes the value for the {@link AbstractToStringHashCode.InternCustomHashCode#a() a} attribute.
     * @param a The value for a 
     * @return {@code this} builder for use in a chained invocation
     */
    public final Builder a(int a) {
      this.a = a;
      initBits &= ~INIT_BIT_A;
      return this;
    }

    /**
     * Builds a new {@link ImmutableInternCustomHashCode ImmutableInternCustomHashCode}.
     * @return An immutable instance of InternCustomHashCode
     * @throws java.lang.IllegalStateException if any required attributes are missing
     */
    public ImmutableInternCustomHashCode build() {
      if (initBits != 0) {
        throw new IllegalStateException(formatRequiredAttributesMessage());
      }
      return ImmutableInternCustomHashCode.validate(new ImmutableInternCustomHashCode(a));
    }

    private String formatRequiredAttributesMessage() {
      List attributes = Lists.newArrayList();
      if ((initBits & INIT_BIT_A) != 0) attributes.add("a");
      return "Cannot build InternCustomHashCode, some of required attributes are not set " + attributes;
    }
  }
}