com.neotys.neoload.model.repository.ImmutableSprintf Maven / Gradle / Ivy
package com.neotys.neoload.model.repository;
import com.fasterxml.jackson.annotation.JsonAutoDetect;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.google.common.base.MoreObjects;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.Lists;
import com.google.errorprone.annotations.CanIgnoreReturnValue;
import com.neotys.neoload.model.core.Element;
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 Sprintf}.
*
* Use the builder to create immutable instances:
* {@code ImmutableSprintf.builder()}.
*/
@SuppressWarnings({"all"})
@ParametersAreNonnullByDefault
@Generated({"Immutables.generator", "Sprintf"})
@Deprecated
@Immutable
@CheckReturnValue
public final class ImmutableSprintf implements Sprintf {
private final String variableName;
private final String format;
private final ImmutableList args;
private final String name;
private final @Nullable String description;
private ImmutableSprintf(
String variableName,
String format,
ImmutableList args,
String name,
@Nullable String description) {
this.variableName = variableName;
this.format = format;
this.args = args;
this.name = name;
this.description = description;
}
/**
* @return The value of the {@code variableName} attribute
*/
@JsonProperty("variableName")
@Override
public String getVariableName() {
return variableName;
}
/**
* @return The value of the {@code format} attribute
*/
@JsonProperty("format")
@Override
public String getFormat() {
return format;
}
/**
* @return The value of the {@code args} attribute
*/
@JsonProperty("args")
@Override
public ImmutableList getArgs() {
return args;
}
/**
* @return The value of the {@code name} attribute
*/
@JsonProperty("name")
@Override
public String getName() {
return name;
}
/**
* @return The value of the {@code description} attribute
*/
@JsonProperty("description")
@Override
public Optional getDescription() {
return Optional.ofNullable(description);
}
/**
* Copy the current immutable object by setting a value for the {@link Sprintf#getVariableName() variableName} attribute.
* An equals check used to prevent copying of the same value by returning {@code this}.
* @param value A new value for variableName
* @return A modified copy of the {@code this} object
*/
public final ImmutableSprintf withVariableName(String value) {
if (this.variableName.equals(value)) return this;
String newValue = Objects.requireNonNull(value, "variableName");
return new ImmutableSprintf(newValue, this.format, this.args, this.name, this.description);
}
/**
* Copy the current immutable object by setting a value for the {@link Sprintf#getFormat() format} attribute.
* An equals check used to prevent copying of the same value by returning {@code this}.
* @param value A new value for format
* @return A modified copy of the {@code this} object
*/
public final ImmutableSprintf withFormat(String value) {
if (this.format.equals(value)) return this;
String newValue = Objects.requireNonNull(value, "format");
return new ImmutableSprintf(this.variableName, newValue, this.args, this.name, this.description);
}
/**
* Copy the current immutable object with elements that replace the content of {@link Sprintf#getArgs() args}.
* @param elements The elements to set
* @return A modified copy of {@code this} object
*/
public final ImmutableSprintf withArgs(String... elements) {
ImmutableList newValue = ImmutableList.copyOf(elements);
return new ImmutableSprintf(this.variableName, this.format, newValue, this.name, this.description);
}
/**
* Copy the current immutable object with elements that replace the content of {@link Sprintf#getArgs() args}.
* A shallow reference equality check is used to prevent copying of the same value by returning {@code this}.
* @param elements An iterable of args elements to set
* @return A modified copy of {@code this} object
*/
public final ImmutableSprintf withArgs(Iterable elements) {
if (this.args == elements) return this;
ImmutableList newValue = ImmutableList.copyOf(elements);
return new ImmutableSprintf(this.variableName, this.format, newValue, this.name, this.description);
}
/**
* Copy the current immutable object by setting a value for the {@link Sprintf#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 ImmutableSprintf withName(String value) {
if (this.name.equals(value)) return this;
String newValue = Objects.requireNonNull(value, "name");
return new ImmutableSprintf(this.variableName, this.format, this.args, newValue, this.description);
}
/**
* Copy the current immutable object by setting a present value for the optional {@link Sprintf#getDescription() description} attribute.
* @param value The value for description
* @return A modified copy of {@code this} object
*/
public final ImmutableSprintf withDescription(String value) {
@Nullable String newValue = Objects.requireNonNull(value, "description");
if (Objects.equals(this.description, newValue)) return this;
return new ImmutableSprintf(this.variableName, this.format, this.args, this.name, newValue);
}
/**
* Copy the current immutable object by setting an optional value for the {@link Sprintf#getDescription() description} 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 description
* @return A modified copy of {@code this} object
*/
public final ImmutableSprintf withDescription(Optional optional) {
@Nullable String value = optional.orElse(null);
if (Objects.equals(this.description, value)) return this;
return new ImmutableSprintf(this.variableName, this.format, this.args, this.name, value);
}
/**
* This instance is equal to all instances of {@code ImmutableSprintf} 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 ImmutableSprintf
&& equalTo((ImmutableSprintf) another);
}
private boolean equalTo(ImmutableSprintf another) {
return variableName.equals(another.variableName)
&& format.equals(another.format)
&& args.equals(another.args)
&& name.equals(another.name)
&& Objects.equals(description, another.description);
}
/**
* Computes a hash code from attributes: {@code variableName}, {@code format}, {@code args}, {@code name}, {@code description}.
* @return hashCode value
*/
@Override
public int hashCode() {
int h = 5381;
h += (h << 5) + variableName.hashCode();
h += (h << 5) + format.hashCode();
h += (h << 5) + args.hashCode();
h += (h << 5) + name.hashCode();
h += (h << 5) + Objects.hashCode(description);
return h;
}
/**
* Prints the immutable value {@code Sprintf} with attribute values.
* @return A string representation of the value
*/
@Override
public String toString() {
return MoreObjects.toStringHelper("Sprintf")
.omitNullValues()
.add("variableName", variableName)
.add("format", format)
.add("args", args)
.add("name", name)
.add("description", description)
.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
@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.NONE)
static final class Json implements Sprintf {
@Nullable String variableName;
@Nullable String format;
List args = ImmutableList.of();
@Nullable String name;
Optional description = Optional.empty();
@JsonProperty("variableName")
public void setVariableName(String variableName) {
this.variableName = variableName;
}
@JsonProperty("format")
public void setFormat(String format) {
this.format = format;
}
@JsonProperty("args")
public void setArgs(List args) {
this.args = args;
}
@JsonProperty("name")
public void setName(String name) {
this.name = name;
}
@JsonProperty("description")
public void setDescription(Optional description) {
this.description = description;
}
@Override
public Element withName(String of) { throw new UnsupportedOperationException(); }
@Override
public String getVariableName() { throw new UnsupportedOperationException(); }
@Override
public String getFormat() { throw new UnsupportedOperationException(); }
@Override
public List getArgs() { throw new UnsupportedOperationException(); }
@Override
public String getName() { throw new UnsupportedOperationException(); }
@Override
public Optional getDescription() { 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 ImmutableSprintf fromJson(Json json) {
ImmutableSprintf.Builder builder = ImmutableSprintf.builder();
if (json.variableName != null) {
builder.variableName(json.variableName);
}
if (json.format != null) {
builder.format(json.format);
}
if (json.args != null) {
builder.addAllArgs(json.args);
}
if (json.name != null) {
builder.name(json.name);
}
if (json.description != null) {
builder.description(json.description);
}
return builder.build();
}
/**
* Creates an immutable copy of a {@link Sprintf} 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 Sprintf instance
*/
public static ImmutableSprintf copyOf(Sprintf instance) {
if (instance instanceof ImmutableSprintf) {
return (ImmutableSprintf) instance;
}
return ImmutableSprintf.builder()
.from(instance)
.build();
}
/**
* Creates a builder for {@link ImmutableSprintf ImmutableSprintf}.
* @return A new ImmutableSprintf builder
*/
public static ImmutableSprintf.Builder builder() {
return new ImmutableSprintf.Builder();
}
/**
* Builds instances of type {@link ImmutableSprintf ImmutableSprintf}.
* 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 static final long INIT_BIT_VARIABLE_NAME = 0x1L;
private static final long INIT_BIT_FORMAT = 0x2L;
private static final long INIT_BIT_NAME = 0x4L;
private long initBits = 0x7L;
private @Nullable String variableName;
private @Nullable String format;
private ImmutableList.Builder args = ImmutableList.builder();
private @Nullable String name;
private @Nullable String description;
private Builder() {
}
/**
* Fill a builder with attribute values from the provided {@code com.neotys.neoload.model.core.Element} instance.
* @param instance The instance from which to copy values
* @return {@code this} builder for use in a chained invocation
*/
@CanIgnoreReturnValue
public final Builder from(Element instance) {
Objects.requireNonNull(instance, "instance");
from((Object) instance);
return this;
}
/**
* Fill a builder with attribute values from the provided {@code com.neotys.neoload.model.repository.Sprintf} instance.
* @param instance The instance from which to copy values
* @return {@code this} builder for use in a chained invocation
*/
@CanIgnoreReturnValue
public final Builder from(Sprintf instance) {
Objects.requireNonNull(instance, "instance");
from((Object) instance);
return this;
}
private void from(Object object) {
if (object instanceof Element) {
Element instance = (Element) object;
name(instance.getName());
Optional descriptionOptional = instance.getDescription();
if (descriptionOptional.isPresent()) {
description(descriptionOptional);
}
}
if (object instanceof Sprintf) {
Sprintf instance = (Sprintf) object;
addAllArgs(instance.getArgs());
format(instance.getFormat());
variableName(instance.getVariableName());
}
}
/**
* Initializes the value for the {@link Sprintf#getVariableName() variableName} attribute.
* @param variableName The value for variableName
* @return {@code this} builder for use in a chained invocation
*/
@CanIgnoreReturnValue
@JsonProperty("variableName")
public final Builder variableName(String variableName) {
this.variableName = Objects.requireNonNull(variableName, "variableName");
initBits &= ~INIT_BIT_VARIABLE_NAME;
return this;
}
/**
* Initializes the value for the {@link Sprintf#getFormat() format} attribute.
* @param format The value for format
* @return {@code this} builder for use in a chained invocation
*/
@CanIgnoreReturnValue
@JsonProperty("format")
public final Builder format(String format) {
this.format = Objects.requireNonNull(format, "format");
initBits &= ~INIT_BIT_FORMAT;
return this;
}
/**
* Adds one element to {@link Sprintf#getArgs() args} list.
* @param element A args element
* @return {@code this} builder for use in a chained invocation
*/
@CanIgnoreReturnValue
public final Builder addArgs(String element) {
this.args.add(element);
return this;
}
/**
* Adds elements to {@link Sprintf#getArgs() args} list.
* @param elements An array of args elements
* @return {@code this} builder for use in a chained invocation
*/
@CanIgnoreReturnValue
public final Builder addArgs(String... elements) {
this.args.add(elements);
return this;
}
/**
* Sets or replaces all elements for {@link Sprintf#getArgs() args} list.
* @param elements An iterable of args elements
* @return {@code this} builder for use in a chained invocation
*/
@CanIgnoreReturnValue
@JsonProperty("args")
public final Builder args(Iterable elements) {
this.args = ImmutableList.builder();
return addAllArgs(elements);
}
/**
* Adds elements to {@link Sprintf#getArgs() args} list.
* @param elements An iterable of args elements
* @return {@code this} builder for use in a chained invocation
*/
@CanIgnoreReturnValue
public final Builder addAllArgs(Iterable elements) {
this.args.addAll(elements);
return this;
}
/**
* Initializes the value for the {@link Sprintf#getName() name} attribute.
* @param name The value for name
* @return {@code this} builder for use in a chained invocation
*/
@CanIgnoreReturnValue
@JsonProperty("name")
public final Builder name(String name) {
this.name = Objects.requireNonNull(name, "name");
initBits &= ~INIT_BIT_NAME;
return this;
}
/**
* Initializes the optional value {@link Sprintf#getDescription() description} to description.
* @param description The value for description
* @return {@code this} builder for chained invocation
*/
@CanIgnoreReturnValue
public final Builder description(String description) {
this.description = Objects.requireNonNull(description, "description");
return this;
}
/**
* Initializes the optional value {@link Sprintf#getDescription() description} to description.
* @param description The value for description
* @return {@code this} builder for use in a chained invocation
*/
@CanIgnoreReturnValue
@JsonProperty("description")
public final Builder description(Optional description) {
this.description = description.orElse(null);
return this;
}
/**
* Builds a new {@link ImmutableSprintf ImmutableSprintf}.
* @return An immutable instance of Sprintf
* @throws java.lang.IllegalStateException if any required attributes are missing
*/
public ImmutableSprintf build() {
if (initBits != 0) {
throw new IllegalStateException(formatRequiredAttributesMessage());
}
return new ImmutableSprintf(variableName, format, args.build(), name, description);
}
private String formatRequiredAttributesMessage() {
List attributes = Lists.newArrayList();
if ((initBits & INIT_BIT_VARIABLE_NAME) != 0) attributes.add("variableName");
if ((initBits & INIT_BIT_FORMAT) != 0) attributes.add("format");
if ((initBits & INIT_BIT_NAME) != 0) attributes.add("name");
return "Cannot build Sprintf, some of required attributes are not set " + attributes;
}
}
}