com.arakelian.elastic.model.ImmutableIntegerRange Maven / Gradle / Ivy

Go to download
package com.arakelian.elastic.model;

import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.google.common.base.MoreObjects;
import com.google.common.primitives.Longs;
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 IntegerRange}.
 * 
 * Use the builder to create immutable instances:
 * {@code ImmutableIntegerRange.builder()}.
 */
@Generated(from = "IntegerRange", generator = "Immutables")
@SuppressWarnings({"all"})
@ParametersAreNonnullByDefault
@javax.annotation.processing.Generated("org.immutables.processor.ProxyProcessor")
@Immutable
@CheckReturnValue
public final class ImmutableIntegerRange implements IntegerRange {
  private final long gte;
  private final long lte;

  private ImmutableIntegerRange(ImmutableIntegerRange.Builder builder) {
    this.gte = builder.gte;
    this.lte = builder.lte;
  }

  /**
   * @return The value of the {@code gte} attribute
   */
  @JsonProperty("gte")
  @Override
  public long getGte() {
    return gte;
  }

  /**
   * @return The value of the {@code lte} attribute
   */
  @JsonProperty("lte")
  @Override
  public long getLte() {
    return lte;
  }

  /**
   * This instance is equal to all instances of {@code ImmutableIntegerRange} 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 ImmutableIntegerRange
        && equalTo((ImmutableIntegerRange) another);
  }

  private boolean equalTo(ImmutableIntegerRange another) {
    return gte == another.gte
        && lte == another.lte;
  }

  /**
   * Computes a hash code from attributes: {@code gte}, {@code lte}.
   * @return hashCode value
   */
  @Override
  public int hashCode() {
    @Var int h = 5381;
    h += (h << 5) + Longs.hashCode(gte);
    h += (h << 5) + Longs.hashCode(lte);
    return h;
  }

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

  /**
   * Creates a builder for {@link ImmutableIntegerRange ImmutableIntegerRange}.
   * 
   * ImmutableIntegerRange.builder()
   *    .gte(long) // required {@link IntegerRange#getGte() gte}
   *    .lte(long) // required {@link IntegerRange#getLte() lte}
   *    .build();
   * 
   * @return A new ImmutableIntegerRange builder
   */
  public static ImmutableIntegerRange.Builder builder() {
    return new ImmutableIntegerRange.Builder();
  }

  /**
   * Builds instances of type {@link ImmutableIntegerRange ImmutableIntegerRange}.
   * 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 = "IntegerRange", generator = "Immutables")
  @NotThreadSafe
  @JsonPropertyOrder({"gte", "lte"})
  public static final class Builder {
    private static final long INIT_BIT_GTE = 0x1L;
    private static final long INIT_BIT_LTE = 0x2L;
    private long initBits = 0x3L;

    private long gte;
    private long lte;

    private Builder() {
    }

    /**
     * Fill a builder with attribute values from the provided {@code IntegerRange} 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(IntegerRange instance) {
      Objects.requireNonNull(instance, "instance");
      gte(instance.getGte());
      lte(instance.getLte());
      return this;
    }

    /**
     * Initializes the value for the {@link IntegerRange#getGte() gte} attribute.
     * @param gte The value for gte 
     * @return {@code this} builder for use in a chained invocation
     */
    @CanIgnoreReturnValue 
    @JsonProperty("gte")
    public final Builder gte(long gte) {
      this.gte = gte;
      initBits &= ~INIT_BIT_GTE;
      return this;
    }

    /**
     * Initializes the value for the {@link IntegerRange#getLte() lte} attribute.
     * @param lte The value for lte 
     * @return {@code this} builder for use in a chained invocation
     */
    @CanIgnoreReturnValue 
    @JsonProperty("lte")
    public final Builder lte(long lte) {
      this.lte = lte;
      initBits &= ~INIT_BIT_LTE;
      return this;
    }

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

    private String formatRequiredAttributesMessage() {
      List attributes = new ArrayList<>();
      if ((initBits & INIT_BIT_GTE) != 0) attributes.add("gte");
      if ((initBits & INIT_BIT_LTE) != 0) attributes.add("lte");
      return "Cannot build IntegerRange, some of required attributes are not set " + attributes;
    }
  }
}