• Home
• com.hubspot.slack
• slack-base
• 1.16.4
• source code
• OptionsList.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.hubspot.slack.client.models.interaction.OptionsList Maven / Gradle / Ivy

package com.hubspot.slack.client.models.interaction;

import com.fasterxml.jackson.annotation.JsonAutoDetect;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.hubspot.slack.client.models.actions.Option;
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
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 OptionsListIF}.
 * 

 * Use the builder to create immutable instances:
 * {@code OptionsList.builder()}.
 */
@Generated(from = "OptionsListIF", generator = "Immutables")
@SuppressWarnings({"all"})
@SuppressFBWarnings
@ParametersAreNonnullByDefault
@javax.annotation.processing.Generated("org.immutables.processor.ProxyProcessor")
@Immutable
public final class OptionsList implements OptionsListIF {
  private final List options;

  private OptionsList(List options) {
    this.options = options;
  }

  /**
   * @return The value of the {@code options} attribute
   */
  @JsonProperty
  @Override
  public List getOptions() {
    return options;
  }

  /**
   * Copy the current immutable object with elements that replace the content of {@link OptionsListIF#getOptions() options}.
   * @param elements The elements to set
   * @return A modified copy of {@code this} object
   */
  public final OptionsList withOptions(Option... elements) {
    List newValue = createUnmodifiableList(false, createSafeList(Arrays.asList(elements), true, false));
    return new OptionsList(newValue);
  }

  /**
   * Copy the current immutable object with elements that replace the content of {@link OptionsListIF#getOptions() options}.
   * A shallow reference equality check is used to prevent copying of the same value by returning {@code this}.
   * @param elements An iterable of options elements to set
   * @return A modified copy of {@code this} object
   */
  public final OptionsList withOptions(Iterable elements) {
    if (this.options == elements) return this;
    List newValue = createUnmodifiableList(false, createSafeList(elements, true, false));
    return new OptionsList(newValue);
  }

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

  private boolean equalTo(int synthetic, OptionsList another) {
    return options.equals(another.options);
  }

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

  /**
   * Prints the immutable value {@code OptionsList} with attribute values.
   * @return A string representation of the value
   */
  @Override
  public String toString() {
    return "OptionsList{"
        + "options=" + options
        + "}";
  }

  /**
   * 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
   */
  @Generated(from = "OptionsListIF", generator = "Immutables")
  @Deprecated
  @JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.NONE)
  static final class Json implements OptionsListIF {
    @Nullable List options = Collections.emptyList();
    @JsonProperty
    public void setOptions(List options) {
      this.options = options;
    }
    @Override
    public List getOptions() { 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(mode = JsonCreator.Mode.DELEGATING)
  static OptionsList fromJson(Json json) {
    OptionsList.Builder builder = OptionsList.builder();
    if (json.options != null) {
      builder.addAllOptions(json.options);
    }
    return builder.build();
  }

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

  /**
   * Creates a builder for {@link OptionsList OptionsList}.
   * 
   * OptionsList.builder()
   *    .addOptions|addAllOptions(com.hubspot.slack.client.models.actions.Option) // {@link OptionsListIF#getOptions() options} elements
   *    .build();
   * 
   * @return A new OptionsList builder
   */
  public static OptionsList.Builder builder() {
    return new OptionsList.Builder();
  }

  /**
   * Builds instances of type {@link OptionsList OptionsList}.
   * 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 = "OptionsListIF", generator = "Immutables")
  @NotThreadSafe
  public static final class Builder {
    private List options = new ArrayList();

    private Builder() {
    }

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

    /**
     * Adds one element to {@link OptionsListIF#getOptions() options} list.
     * @param element A options element
     * @return {@code this} builder for use in a chained invocation
     */
    public final Builder addOptions(Option element) {
      this.options.add(Objects.requireNonNull(element, "options element"));
      return this;
    }

    /**
     * Adds elements to {@link OptionsListIF#getOptions() options} list.
     * @param elements An array of options elements
     * @return {@code this} builder for use in a chained invocation
     */
    public final Builder addOptions(Option... elements) {
      for (Option element : elements) {
        this.options.add(Objects.requireNonNull(element, "options element"));
      }
      return this;
    }


    /**
     * Sets or replaces all elements for {@link OptionsListIF#getOptions() options} list.
     * @param elements An iterable of options elements
     * @return {@code this} builder for use in a chained invocation
     */
    public final Builder setOptions(Iterable elements) {
      this.options.clear();
      return addAllOptions(elements);
    }

    /**
     * Adds elements to {@link OptionsListIF#getOptions() options} list.
     * @param elements An iterable of options elements
     * @return {@code this} builder for use in a chained invocation
     */
    public final Builder addAllOptions(Iterable elements) {
      for (Option element : elements) {
        this.options.add(Objects.requireNonNull(element, "options element"));
      }
      return this;
    }

    /**
     * Builds a new {@link OptionsList OptionsList}.
     * @return An immutable instance of OptionsList
     * @throws com.hubspot.immutables.validation.InvalidImmutableStateException if any required attributes are missing
     */
    public OptionsList build() {
      return new OptionsList(createUnmodifiableList(true, options));
    }
  }

  private static  List createSafeList(Iterable iterable, boolean checkNulls, boolean skipNulls) {
    ArrayList list;
    if (iterable instanceof Collection) {
      int size = ((Collection) iterable).size();
      if (size == 0) return Collections.emptyList();
      list = new ArrayList<>(size);
    } else {
      list = new ArrayList<>();
    }
    for (T element : iterable) {
      if (skipNulls && element == null) continue;
      if (checkNulls) Objects.requireNonNull(element, "element");
      list.add(element);
    }
    return list;
  }

  private static  List createUnmodifiableList(boolean clone, List list) {
    switch(list.size()) {
    case 0: return Collections.emptyList();
    case 1: return Collections.singletonList(list.get(0));
    default:
      if (clone) {
        return Collections.unmodifiableList(new ArrayList<>(list));
      } else {
        if (list instanceof ArrayList) {
          ((ArrayList) list).trimToSize();
        }
        return Collections.unmodifiableList(list);
      }
    }
  }
}