org.immutables.fixture.jackson.ImmutableDatasetIdLocator Maven / Gradle / Ivy

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

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonTypeInfo;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.google.common.base.MoreObjects;
import com.google.common.base.Preconditions;
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 PolymorphicMappings.DatasetIdLocator}.
 * 
 * Use the builder to create immutable instances:
 * {@code new PolymorphicMappings.DatasetIdLocator.Builder()}.
 */
@SuppressWarnings("all")
@ParametersAreNonnullByDefault
@Generated({"Immutables.generator", "PolymorphicMappings.DatasetIdLocator"})
@Immutable
final class ImmutableDatasetIdLocator
    implements PolymorphicMappings.DatasetIdLocator {
  private final String datasetId;

  private ImmutableDatasetIdLocator(String datasetId) {
    this.datasetId = datasetId;
  }

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

  /**
   * Copy the current immutable object by setting a value for the {@link PolymorphicMappings.DatasetIdLocator#getDatasetId() datasetId} attribute.
   * An equals check used to prevent copying of the same value by returning {@code this}.
   * @param datasetId A new value for datasetId
   * @return A modified copy of the {@code this} object
   */
  public final ImmutableDatasetIdLocator withDatasetId(String datasetId) {
    if (this.datasetId.equals(datasetId)) return this;
    String newValue = Preconditions.checkNotNull(datasetId, "datasetId");
    return new ImmutableDatasetIdLocator(newValue);
  }

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

  private boolean equalTo(ImmutableDatasetIdLocator another) {
    return datasetId.equals(another.datasetId);
  }

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

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

  /**
   * Utility type used to correctly read immutable object from JSON representation.
   * @deprecated Do not use this type directly, it exists only for the Jackson-binding infrastructure
   */
  @Deprecated
  @JsonDeserialize
  @JsonTypeInfo(use=JsonTypeInfo.Id.NONE)
  static final class Json implements PolymorphicMappings.DatasetIdLocator {
    @Nullable String datasetId;
    @JsonProperty("datasetId")
    public void setDatasetId(String datasetId) {
      this.datasetId = datasetId;
    }
    @Override
    public String getDatasetId() { throw new UnsupportedOperationException(); }
  }

  /**
   * @param json A JSON-bindable data structure
   * @return An immutable value type
   * @deprecated Do not use this method directly, it exists only for the Jackson-binding infrastructure
   */
  @Deprecated
  @JsonCreator
  static ImmutableDatasetIdLocator fromJson(Json json) {
    PolymorphicMappings.DatasetIdLocator.Builder builder = new PolymorphicMappings.DatasetIdLocator.Builder();
    if (json.datasetId != null) {
      builder.datasetId(json.datasetId);
    }
    return builder.build();
  }

  /**
   * Creates an immutable copy of a {@link PolymorphicMappings.DatasetIdLocator} 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 DatasetIdLocator instance
   */
  public static ImmutableDatasetIdLocator copyOf(PolymorphicMappings.DatasetIdLocator instance) {
    if (instance instanceof ImmutableDatasetIdLocator) {
      return (ImmutableDatasetIdLocator) instance;
    }
    return new PolymorphicMappings.DatasetIdLocator.Builder()
        .from(instance)
        .build();
  }

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

    private @Nullable String datasetId;

    /**
     * Creates a builder for {@link ImmutableDatasetIdLocator ImmutableDatasetIdLocator} instances.
     */
    Builder() {
      if (!(this instanceof PolymorphicMappings.DatasetIdLocator.Builder)) {
        throw new UnsupportedOperationException("Use: new PolymorphicMappings.DatasetIdLocator.Builder()");
      }
    }

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

    /**
     * Initializes the value for the {@link PolymorphicMappings.DatasetIdLocator#getDatasetId() datasetId} attribute.
     * @param datasetId The value for datasetId 
     * @return {@code this} builder for use in a chained invocation
     */
    public final PolymorphicMappings.DatasetIdLocator.Builder datasetId(String datasetId) {
      this.datasetId = Preconditions.checkNotNull(datasetId, "datasetId");
      initBits &= ~INIT_BIT_DATASET_ID;
      return (PolymorphicMappings.DatasetIdLocator.Builder) this;
    }

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

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