org.immutables.fixture.serial.ModifiableSomeSer Maven / Gradle / Ivy

Go to download
package org.immutables.fixture.serial;

import com.google.common.base.MoreObjects;
import com.google.common.base.Preconditions;
import javax.annotation.Generated;
import javax.annotation.Nullable;
import javax.annotation.ParametersAreNonnullByDefault;
import javax.annotation.concurrent.NotThreadSafe;

/**
 * A modifiable implementation of the {@link SomeSer SomeSer} type.
 * Use the {@link #create()} static factory methods to create new instances.
 * Use the {@link #toImmutable()} method to convert to canonical immutable instances.
 * 
ModifiableSomeSer is not thread-safe
 * @see ImmutableSomeSer
 */
@SuppressWarnings("all")
@ParametersAreNonnullByDefault
@Generated({"Modifiables.generator", "SomeSer"})
@NotThreadSafe
public final class ModifiableSomeSer extends SomeSer {
  private static final long serialVersionUID = 1L;

  private static final long OPT_BIT_REGULAR = 0x1L;
  private long optBits;

  private int regular;

  private ModifiableSomeSer() {}

  /**
   * Construct a modifiable instance of {@code SomeSer}.
   * @return A new modifiable instance
   */
  public static ModifiableSomeSer create() {
    return new ModifiableSomeSer();
  }

  /**
   * @return assigned or, otherwise, newly computed, not cached value of {@code regular} attribute
   */
  @Override
  final int regular() {
    return regularIsSet()
        ? regular
        : super.regular();
  }

  /**
   * Clears the object by setting all attributes to their initial values.
   * @return {@code this} for use in a chained invocation
   */
  public ModifiableSomeSer clear() {
    optBits = 0;
    regular = 0;
    return this;
  }

  /**
   * Fill this modifiable instance with attribute values from the provided {@link SomeSer} instance.
   * Regular attribute values will be overridden, i.e. replaced with ones of an instance.
   * Any of the instance's absent optional values will not be copied (will not override current values).
   * @param instance The instance from which to copy values
   * @return {@code this} for use in a chained invocation
   */
  public ModifiableSomeSer from(SomeSer instance) {
    Preconditions.checkNotNull(instance, "instance");
    setRegular(instance.regular());
    return this;
  }

  /**
   * Assigns a value to the {@link SomeSer#regular() regular} attribute.
   * If not set, this attribute will have a default value returned by the initializer of {@link SomeSer#regular() regular}.
   * @param regular The value for regular
   * @return {@code this} for use in a chained invocation
   */
  public ModifiableSomeSer setRegular(int regular) {
    this.regular = regular;
    optBits |= OPT_BIT_REGULAR;
    return this;
  }

  /**
   * Returns {@code true} if the default attribute {@link SomeSer#regular() regular} is set.
   * @return {@code true} if set
   */
  public final boolean regularIsSet() {
    return (optBits & OPT_BIT_REGULAR) != 0;
  }

  /**
   * Returns {@code true} if all required attributes are set, indicating that the object is initialized.
   * @return {@code true} if set
   */
  public final boolean isInitialized() {
    return true;
  }

  /**
   * Converts to {@link ImmutableSomeSer ImmutableSomeSer}.
   * @return An immutable instance of SomeSer
   */
  public final ImmutableSomeSer toImmutable() {
    return ImmutableSomeSer.copyOf(this);
  }

  /**
   * This instance is equal to all instances of {@code ModifiableSomeSer} 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;
    if (!(another instanceof ModifiableSomeSer)) return false;
    ModifiableSomeSer other = (ModifiableSomeSer) another;
    return equalTo(other);
  }

  private boolean equalTo(ModifiableSomeSer another) {
    int regular = regular();
    return regular == another.regular();
  }

  /**
   * Computes a hash code from attributes: {@code regular}.
   * @return hashCode value
   */
  @Override
  public int hashCode() {
    int h = 31;
    int regular = regular();
    h = h * 17 + regular;
    return h;
  }

  /**
   * Generates a string representation of this {@code SomeSer}.
   * If uninitialized, some attribute values may appear as question marks.
   * @return A string representation
   */
  @Override
  public String toString() {
    return MoreObjects.toStringHelper("ModifiableSomeSer")
        .add("regular", regular())
        .toString();
  }
}