com.neotys.neoload.model.v3.util.ImmutableParameter Maven / Gradle / Ivy

Go to download
package com.neotys.neoload.model.v3.util;

import com.google.common.base.MoreObjects;
import com.google.common.collect.Lists;
import com.google.errorprone.annotations.CanIgnoreReturnValue;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
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 Parameter}.
 * 
 * Use the builder to create immutable instances:
 * {@code new Parameter.Builder()}.
 */
@SuppressWarnings({"all"})
@ParametersAreNonnullByDefault
@Generated({"Immutables.generator", "Parameter"})
@Immutable
@CheckReturnValue
public final class ImmutableParameter implements Parameter {
  private final String name;
  private final @Nullable String value;

  private ImmutableParameter(String name, @Nullable String value) {
    this.name = name;
    this.value = value;
  }

  /**
   * @return The value of the {@code name} attribute
   */
  @Override
  public String getName() {
    return name;
  }

  /**
   * @return The value of the {@code value} attribute
   */
  @Override
  public Optional getValue() {
    return Optional.ofNullable(value);
  }

  /**
   * Copy the current immutable object by setting a value for the {@link Parameter#getName() name} attribute.
   * An equals check used to prevent copying of the same value by returning {@code this}.
   * @param value A new value for name
   * @return A modified copy of the {@code this} object
   */
  public final ImmutableParameter withName(String value) {
    if (this.name.equals(value)) return this;
    String newValue = Objects.requireNonNull(value, "name");
    return new ImmutableParameter(newValue, this.value);
  }

  /**
   * Copy the current immutable object by setting a present value for the optional {@link Parameter#getValue() value} attribute.
   * @param value The value for value
   * @return A modified copy of {@code this} object
   */
  public final ImmutableParameter withValue(String value) {
    @Nullable String newValue = Objects.requireNonNull(value, "value");
    if (Objects.equals(this.value, newValue)) return this;
    return new ImmutableParameter(this.name, newValue);
  }

  /**
   * Copy the current immutable object by setting an optional value for the {@link Parameter#getValue() value} attribute.
   * An equality check is used on inner nullable value to prevent copying of the same value by returning {@code this}.
   * @param optional A value for value
   * @return A modified copy of {@code this} object
   */
  public final ImmutableParameter withValue(Optional optional) {
    @Nullable String value = optional.orElse(null);
    if (Objects.equals(this.value, value)) return this;
    return new ImmutableParameter(this.name, value);
  }

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

  private boolean equalTo(ImmutableParameter another) {
    return name.equals(another.name)
        && Objects.equals(value, another.value);
  }

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

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

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

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

    private @Nullable String name;
    private @Nullable String value;

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

    /**
     * Fill a builder with attribute values from the provided {@code Parameter} 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 Parameter.Builder from(Parameter instance) {
      Objects.requireNonNull(instance, "instance");
      name(instance.getName());
      Optional valueOptional = instance.getValue();
      if (valueOptional.isPresent()) {
        value(valueOptional);
      }
      return (Parameter.Builder) this;
    }

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

    /**
     * Initializes the optional value {@link Parameter#getValue() value} to value.
     * @param value The value for value
     * @return {@code this} builder for chained invocation
     */
    @CanIgnoreReturnValue 
    public final Parameter.Builder value(String value) {
      this.value = Objects.requireNonNull(value, "value");
      return (Parameter.Builder) this;
    }

    /**
     * Initializes the optional value {@link Parameter#getValue() value} to value.
     * @param value The value for value
     * @return {@code this} builder for use in a chained invocation
     */
    @CanIgnoreReturnValue 
    public final Parameter.Builder value(Optional value) {
      this.value = value.orElse(null);
      return (Parameter.Builder) this;
    }

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

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