com.arakelian.elastic.model.search.ImmutableCollapse Maven / Gradle / Ivy

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

import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
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 Collapse}.
 * 
 * Use the builder to create immutable instances:
 * {@code ImmutableCollapse.builder()}.
 */
@Generated(from = "Collapse", generator = "Immutables")
@SuppressWarnings({"all"})
@ParametersAreNonnullByDefault
@javax.annotation.Generated("org.immutables.processor.ProxyProcessor")
@Immutable
@CheckReturnValue
public final class ImmutableCollapse implements Collapse {
  private final String fieldName;

  private ImmutableCollapse(ImmutableCollapse.Builder builder) {
    this.fieldName = builder.fieldName;
  }

  /**
   * @return The value of the {@code fieldName} attribute
   */
  @JsonProperty("fieldName")
  @Override
  public String getFieldName() {
    return fieldName;
  }

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

  private boolean equalTo(ImmutableCollapse another) {
    return fieldName.equals(another.fieldName);
  }

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

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

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

  /**
   * Builds instances of type {@link ImmutableCollapse ImmutableCollapse}.
   * 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 = "Collapse", generator = "Immutables")
  @NotThreadSafe
  @JsonPropertyOrder("name")
  public static final class Builder {
    private static final long INIT_BIT_FIELD_NAME = 0x1L;
    private long initBits = 0x1L;

    private @Nullable String fieldName;

    private Builder() {
    }

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

    /**
     * Initializes the value for the {@link Collapse#getFieldName() fieldName} attribute.
     * @param fieldName The value for fieldName 
     * @return {@code this} builder for use in a chained invocation
     */
    @CanIgnoreReturnValue 
    @JsonProperty("fieldName")
    public final Builder fieldName(String fieldName) {
      this.fieldName = Objects.requireNonNull(fieldName, "fieldName");
      initBits &= ~INIT_BIT_FIELD_NAME;
      return this;
    }

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

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