com.arakelian.elastic.model.aggs.bucket.ImmutableBucketOrder Maven / Gradle / Ivy
package com.arakelian.elastic.model.aggs.bucket;
import com.arakelian.elastic.model.enums.SortOrder;
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.Generated;
import javax.annotation.Nullable;
import javax.annotation.ParametersAreNonnullByDefault;
import javax.annotation.concurrent.Immutable;
import javax.annotation.concurrent.NotThreadSafe;
/**
* Immutable implementation of {@link BucketOrder}.
*
* Use the builder to create immutable instances:
* {@code ImmutableBucketOrder.builder()}.
*/
@SuppressWarnings({"all"})
@ParametersAreNonnullByDefault
@Generated("org.immutables.processor.ProxyProcessor")
@Immutable
@CheckReturnValue
public final class ImmutableBucketOrder implements BucketOrder {
private final String fieldName;
private final SortOrder order;
private ImmutableBucketOrder(ImmutableBucketOrder.Builder builder) {
this.fieldName = builder.fieldName;
this.order = builder.order != null
? builder.order
: Objects.requireNonNull(BucketOrder.super.getOrder(), "order");
}
/**
* Returns the field to sort by.
*
* - The field names
_term and _time are deprecated, but synonymous
* with reserved field name _key which orders the buckets alphabetically by
* term.
* - The field name
_count is reserved and order the buckets by their document
* count
* - Any other field name is are sorting on a sub-aggregation
*
* @return the field to sort by
* @see InternalOrder.java
*/
@JsonProperty("field")
@Override
public String getFieldName() {
return fieldName;
}
/**
* @return The value of the {@code order} attribute
*/
@JsonProperty("order")
@Override
public SortOrder getOrder() {
return order;
}
/**
* This instance is equal to all instances of {@code ImmutableBucketOrder} 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 ImmutableBucketOrder
&& equalTo((ImmutableBucketOrder) another);
}
private boolean equalTo(ImmutableBucketOrder another) {
return fieldName.equals(another.fieldName)
&& order.equals(another.order);
}
/**
* Computes a hash code from attributes: {@code fieldName}, {@code order}.
* @return hashCode value
*/
@Override
public int hashCode() {
@Var int h = 5381;
h += (h << 5) + fieldName.hashCode();
h += (h << 5) + order.hashCode();
return h;
}
/**
* Prints the immutable value {@code BucketOrder} with attribute values.
* @return A string representation of the value
*/
@Override
public String toString() {
return MoreObjects.toStringHelper("BucketOrder")
.omitNullValues()
.add("fieldName", fieldName)
.add("order", order)
.toString();
}
/**
* Creates a builder for {@link ImmutableBucketOrder ImmutableBucketOrder}.
* @return A new ImmutableBucketOrder builder
*/
public static ImmutableBucketOrder.Builder builder() {
return new ImmutableBucketOrder.Builder();
}
/**
* Builds instances of type {@link ImmutableBucketOrder ImmutableBucketOrder}.
* 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
@JsonPropertyOrder({"field", "order"})
public static final class Builder {
private static final long INIT_BIT_FIELD_NAME = 0x1L;
private long initBits = 0x1L;
private @Nullable String fieldName;
private @Nullable SortOrder order;
private Builder() {
}
/**
* Fill a builder with attribute values from the provided {@code BucketOrder} 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(BucketOrder instance) {
Objects.requireNonNull(instance, "instance");
fieldName(instance.getFieldName());
order(instance.getOrder());
return this;
}
/**
* Initializes the value for the {@link BucketOrder#getFieldName() fieldName} attribute.
* @param fieldName The value for fieldName
* @return {@code this} builder for use in a chained invocation
*/
@CanIgnoreReturnValue
@JsonProperty("field")
public final Builder fieldName(String fieldName) {
this.fieldName = Objects.requireNonNull(fieldName, "fieldName");
initBits &= ~INIT_BIT_FIELD_NAME;
return this;
}
/**
* Initializes the value for the {@link BucketOrder#getOrder() order} attribute.
*
If not set, this attribute will have a default value as returned by the initializer of {@link BucketOrder#getOrder() order}.
* @param order The value for order
* @return {@code this} builder for use in a chained invocation
*/
@CanIgnoreReturnValue
@JsonProperty("order")
public final Builder order(SortOrder order) {
this.order = Objects.requireNonNull(order, "order");
return this;
}
/**
* Builds a new {@link ImmutableBucketOrder ImmutableBucketOrder}.
* @return An immutable instance of BucketOrder
* @throws java.lang.IllegalStateException if any required attributes are missing
*/
public ImmutableBucketOrder build() {
if (initBits != 0) {
throw new IllegalStateException(formatRequiredAttributesMessage());
}
return new ImmutableBucketOrder(this);
}
private String formatRequiredAttributesMessage() {
List attributes = new ArrayList<>();
if ((initBits & INIT_BIT_FIELD_NAME) != 0) attributes.add("fieldName");
return "Cannot build BucketOrder, some of required attributes are not set " + attributes;
}
}
}