org.immutables.fixture.ast.ImmutableStringNode Maven / Gradle / Ivy

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

import com.google.common.base.MoreObjects;
import com.google.common.base.Preconditions;
import com.google.common.collect.ImmutableList;
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 InstantiationGenerics.StringNode}.
 * 
 * Use the builder to create immutable instances:
 * {@code ImmutableStringNode.builder()}.
 */
@SuppressWarnings("all")
@ParametersAreNonnullByDefault
@Generated({"Immutables.generator", "InstantiationGenerics.StringNode"})
@Immutable
public final class ImmutableStringNode implements InstantiationGenerics.StringNode {
  private final ImmutableList> elements;

  private ImmutableStringNode(
      ImmutableList> elements) {
    this.elements = elements;
  }

  /**
   * @return The value of the {@code elements} attribute
   */
  @Override
  public ImmutableList> elements() {
    return elements;
  }

  /**
   * Copy the current immutable object with elements that replace the content of {@link InstantiationGenerics.StringNode#elements() elements}.
   * @param elements The elements to set
   * @return A modified copy of {@code this} object
   */
  @SafeVarargs
  public final ImmutableStringNode withElements(InstantiationGenerics.TreeElement... elements) {
    ImmutableList> newValue = ImmutableList.copyOf(elements);
    return new ImmutableStringNode(newValue);
  }

  /**
   * Copy the current immutable object with elements that replace the content of {@link InstantiationGenerics.StringNode#elements() elements}.
   * A shallow reference equality check is used to prevent copying of the same value by returning {@code this}.
   * @param elements An iterable of elements elements to set
   * @return A modified copy of {@code this} object
   */
  public final ImmutableStringNode withElements(Iterable> elements) {
    if (this.elements == elements) return this;
    ImmutableList> newValue = ImmutableList.copyOf(elements);
    return new ImmutableStringNode(newValue);
  }

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

  private boolean equalTo(ImmutableStringNode another) {
    return elements.equals(another.elements);
  }

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

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

  /**
   * Creates an immutable copy of a {@link InstantiationGenerics.StringNode} 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 StringNode instance
   */
  public static ImmutableStringNode copyOf(InstantiationGenerics.StringNode instance) {
    if (instance instanceof ImmutableStringNode) {
      return (ImmutableStringNode) instance;
    }
    return ImmutableStringNode.builder()
        .from(instance)
        .build();
  }

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

  /**
   * Builds instances of type {@link ImmutableStringNode ImmutableStringNode}.
   * 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
  public static final class Builder {
    private ImmutableList.Builder> elements = ImmutableList.builder();

    private Builder() {
    }

    /**
     * Fill a builder with attribute values from the provided {@code StringNode} instance.
     * Regular attribute values will be replaced with those from the given instance.
     * Absent optional values will not replace present values.
     * Collection elements and entries will be added, not replaced.
     * @param instance The instance from which to copy values
     * @return {@code this} builder for use in a chained invocation
     */
    public final Builder from(InstantiationGenerics.StringNode instance) {
      Preconditions.checkNotNull(instance, "instance");
      addAllElements(instance.elements());
      return this;
    }

    /**
     * Adds one element to {@link InstantiationGenerics.StringNode#elements() elements} list.
     * @param element A elements element
     * @return {@code this} builder for use in a chained invocation
     */
    public final Builder addElements(InstantiationGenerics.TreeElement element) {
      this.elements.add(element);
      return this;
    }

    /**
     * Adds elements to {@link InstantiationGenerics.StringNode#elements() elements} list.
     * @param elements An array of elements elements
     * @return {@code this} builder for use in a chained invocation
     */
    @SafeVarargs
    public final Builder addElements(InstantiationGenerics.TreeElement... elements) {
      this.elements.add(elements);
      return this;
    }

    /**
     * Sets or replaces all elements for {@link InstantiationGenerics.StringNode#elements() elements} list.
     * @param elements An iterable of elements elements
     * @return {@code this} builder for use in a chained invocation
     */
    public final Builder elements(Iterable> elements) {
      this.elements = ImmutableList.builder();
      return addAllElements(elements);
    }

    /**
     * Adds elements to {@link InstantiationGenerics.StringNode#elements() elements} list.
     * @param elements An iterable of elements elements
     * @return {@code this} builder for use in a chained invocation
     */
    public final Builder addAllElements(Iterable> elements) {
      this.elements.addAll(elements);
      return this;
    }

    /**
     * Builds a new {@link ImmutableStringNode ImmutableStringNode}.
     * @return An immutable instance of StringNode
     * @throws java.lang.IllegalStateException if any required attributes are missing
     */
    public ImmutableStringNode build() {
      return new ImmutableStringNode(elements.build());
    }
  }
}