com.neotys.neoload.model.v3.project.userpath.ImmutableCustomActionParameter Maven / Gradle / Ivy
package com.neotys.neoload.model.v3.project.userpath;
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 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 CustomActionParameter}.
*
* Use the builder to create immutable instances:
* {@code new CustomActionParameter.Builder()}.
*/
@SuppressWarnings({"all"})
@ParametersAreNonnullByDefault
@Generated({"Immutables.generator", "CustomActionParameter"})
@Immutable
@CheckReturnValue
public final class ImmutableCustomActionParameter
implements CustomActionParameter {
private final String name;
private final String value;
private final CustomActionParameter.Type type;
private ImmutableCustomActionParameter(
String name,
String value,
CustomActionParameter.Type type) {
this.name = name;
this.value = value;
this.type = type;
}
/**
* @return The value of the {@code name} attribute
*/
@Override
public String getName() {
return name;
}
/**
* @return The value of the {@code value} attribute
*/
@Override
public String getValue() {
return value;
}
/**
* @return The value of the {@code type} attribute
*/
@Override
public CustomActionParameter.Type getType() {
return type;
}
/**
* Copy the current immutable object by setting a value for the {@link CustomActionParameter#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 ImmutableCustomActionParameter withName(String value) {
if (this.name.equals(value)) return this;
String newValue = Objects.requireNonNull(value, "name");
return new ImmutableCustomActionParameter(newValue, this.value, this.type);
}
/**
* Copy the current immutable object by setting a value for the {@link CustomActionParameter#getValue() value} attribute.
* An equals check used to prevent copying of the same value by returning {@code this}.
* @param value A new value for value
* @return A modified copy of the {@code this} object
*/
public final ImmutableCustomActionParameter withValue(String value) {
if (this.value.equals(value)) return this;
String newValue = Objects.requireNonNull(value, "value");
return new ImmutableCustomActionParameter(this.name, newValue, this.type);
}
/**
* Copy the current immutable object by setting a value for the {@link CustomActionParameter#getType() type} attribute.
* A value equality check is used to prevent copying of the same value by returning {@code this}.
* @param value A new value for type
* @return A modified copy of the {@code this} object
*/
public final ImmutableCustomActionParameter withType(CustomActionParameter.Type value) {
if (this.type == value) return this;
CustomActionParameter.Type newValue = Objects.requireNonNull(value, "type");
return new ImmutableCustomActionParameter(this.name, this.value, newValue);
}
/**
* This instance is equal to all instances of {@code ImmutableCustomActionParameter} 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 ImmutableCustomActionParameter
&& equalTo((ImmutableCustomActionParameter) another);
}
private boolean equalTo(ImmutableCustomActionParameter another) {
return name.equals(another.name)
&& value.equals(another.value)
&& type.equals(another.type);
}
/**
* Computes a hash code from attributes: {@code name}, {@code value}, {@code type}.
* @return hashCode value
*/
@Override
public int hashCode() {
int h = 5381;
h += (h << 5) + name.hashCode();
h += (h << 5) + value.hashCode();
h += (h << 5) + type.hashCode();
return h;
}
/**
* Prints the immutable value {@code CustomActionParameter} with attribute values.
* @return A string representation of the value
*/
@Override
public String toString() {
return MoreObjects.toStringHelper("CustomActionParameter")
.omitNullValues()
.add("name", name)
.add("value", value)
.add("type", type)
.toString();
}
/**
* Creates an immutable copy of a {@link CustomActionParameter} 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 CustomActionParameter instance
*/
public static ImmutableCustomActionParameter copyOf(CustomActionParameter instance) {
if (instance instanceof ImmutableCustomActionParameter) {
return (ImmutableCustomActionParameter) instance;
}
return new CustomActionParameter.Builder()
.from(instance)
.build();
}
/**
* Builds instances of type {@link ImmutableCustomActionParameter ImmutableCustomActionParameter}.
* 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 static final long INIT_BIT_VALUE = 0x2L;
private static final long INIT_BIT_TYPE = 0x4L;
private long initBits = 0x7L;
private @Nullable String name;
private @Nullable String value;
private @Nullable CustomActionParameter.Type type;
/**
* Creates a builder for {@link ImmutableCustomActionParameter ImmutableCustomActionParameter} instances.
*/
public Builder() {
if (!(this instanceof CustomActionParameter.Builder)) {
throw new UnsupportedOperationException("Use: new CustomActionParameter.Builder()");
}
}
/**
* Fill a builder with attribute values from the provided {@code CustomActionParameter} 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 CustomActionParameter.Builder from(CustomActionParameter instance) {
Objects.requireNonNull(instance, "instance");
name(instance.getName());
value(instance.getValue());
type(instance.getType());
return (CustomActionParameter.Builder) this;
}
/**
* Initializes the value for the {@link CustomActionParameter#getName() name} attribute.
* @param name The value for name
* @return {@code this} builder for use in a chained invocation
*/
@CanIgnoreReturnValue
public final CustomActionParameter.Builder name(String name) {
this.name = Objects.requireNonNull(name, "name");
initBits &= ~INIT_BIT_NAME;
return (CustomActionParameter.Builder) this;
}
/**
* Initializes the value for the {@link CustomActionParameter#getValue() value} attribute.
* @param value The value for value
* @return {@code this} builder for use in a chained invocation
*/
@CanIgnoreReturnValue
public final CustomActionParameter.Builder value(String value) {
this.value = Objects.requireNonNull(value, "value");
initBits &= ~INIT_BIT_VALUE;
return (CustomActionParameter.Builder) this;
}
/**
* Initializes the value for the {@link CustomActionParameter#getType() type} attribute.
* @param type The value for type
* @return {@code this} builder for use in a chained invocation
*/
@CanIgnoreReturnValue
public final CustomActionParameter.Builder type(CustomActionParameter.Type type) {
this.type = Objects.requireNonNull(type, "type");
initBits &= ~INIT_BIT_TYPE;
return (CustomActionParameter.Builder) this;
}
/**
* Builds a new {@link ImmutableCustomActionParameter ImmutableCustomActionParameter}.
* @return An immutable instance of CustomActionParameter
* @throws java.lang.IllegalStateException if any required attributes are missing
*/
public ImmutableCustomActionParameter build() {
if (initBits != 0) {
throw new IllegalStateException(formatRequiredAttributesMessage());
}
return new ImmutableCustomActionParameter(name, value, type);
}
private String formatRequiredAttributesMessage() {
List attributes = Lists.newArrayList();
if ((initBits & INIT_BIT_NAME) != 0) attributes.add("name");
if ((initBits & INIT_BIT_VALUE) != 0) attributes.add("value");
if ((initBits & INIT_BIT_TYPE) != 0) attributes.add("type");
return "Cannot build CustomActionParameter, some of required attributes are not set " + attributes;
}
}
}