com.neotys.neoload.model.v3.validation.validator.ImmutableValidation Maven / Gradle / Ivy
package com.neotys.neoload.model.v3.validation.validator;
import com.google.common.base.MoreObjects;
import com.google.common.collect.Lists;
import com.google.common.primitives.Booleans;
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 Validation}.
*
* Use the builder to create immutable instances:
* {@code new Validation.Builder()}.
*/
@SuppressWarnings({"all"})
@ParametersAreNonnullByDefault
@Generated({"Immutables.generator", "Validation"})
@Immutable
@CheckReturnValue
public final class ImmutableValidation implements Validation {
private final boolean isValid;
private final @Nullable String message;
private ImmutableValidation(boolean isValid, @Nullable String message) {
this.isValid = isValid;
this.message = message;
}
/**
* @return The value of the {@code isValid} attribute
*/
@Override
public boolean isValid() {
return isValid;
}
/**
* @return The value of the {@code message} attribute
*/
@Override
public Optional getMessage() {
return Optional.ofNullable(message);
}
/**
* Copy the current immutable object by setting a value for the {@link Validation#isValid() isValid} attribute.
* A value equality check is used to prevent copying of the same value by returning {@code this}.
* @param value A new value for isValid
* @return A modified copy of the {@code this} object
*/
public final ImmutableValidation withIsValid(boolean value) {
if (this.isValid == value) return this;
return new ImmutableValidation(value, this.message);
}
/**
* Copy the current immutable object by setting a present value for the optional {@link Validation#getMessage() message} attribute.
* @param value The value for message
* @return A modified copy of {@code this} object
*/
public final ImmutableValidation withMessage(String value) {
@Nullable String newValue = Objects.requireNonNull(value, "message");
if (Objects.equals(this.message, newValue)) return this;
return new ImmutableValidation(this.isValid, newValue);
}
/**
* Copy the current immutable object by setting an optional value for the {@link Validation#getMessage() message} 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 message
* @return A modified copy of {@code this} object
*/
public final ImmutableValidation withMessage(Optional optional) {
@Nullable String value = optional.orElse(null);
if (Objects.equals(this.message, value)) return this;
return new ImmutableValidation(this.isValid, value);
}
/**
* This instance is equal to all instances of {@code ImmutableValidation} 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 ImmutableValidation
&& equalTo((ImmutableValidation) another);
}
private boolean equalTo(ImmutableValidation another) {
return isValid == another.isValid
&& Objects.equals(message, another.message);
}
/**
* Computes a hash code from attributes: {@code isValid}, {@code message}.
* @return hashCode value
*/
@Override
public int hashCode() {
int h = 5381;
h += (h << 5) + Booleans.hashCode(isValid);
h += (h << 5) + Objects.hashCode(message);
return h;
}
/**
* Prints the immutable value {@code Validation} with attribute values.
* @return A string representation of the value
*/
@Override
public String toString() {
return MoreObjects.toStringHelper("Validation")
.omitNullValues()
.add("isValid", isValid)
.add("message", message)
.toString();
}
/**
* Creates an immutable copy of a {@link Validation} 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 Validation instance
*/
public static ImmutableValidation copyOf(Validation instance) {
if (instance instanceof ImmutableValidation) {
return (ImmutableValidation) instance;
}
return new Validation.Builder()
.from(instance)
.build();
}
/**
* Builds instances of type {@link ImmutableValidation ImmutableValidation}.
* 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_IS_VALID = 0x1L;
private long initBits = 0x1L;
private boolean isValid;
private @Nullable String message;
/**
* Creates a builder for {@link ImmutableValidation ImmutableValidation} instances.
*/
public Builder() {
if (!(this instanceof Validation.Builder)) {
throw new UnsupportedOperationException("Use: new Validation.Builder()");
}
}
/**
* Fill a builder with attribute values from the provided {@code Validation} 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 Validation.Builder from(Validation instance) {
Objects.requireNonNull(instance, "instance");
isValid(instance.isValid());
Optional messageOptional = instance.getMessage();
if (messageOptional.isPresent()) {
message(messageOptional);
}
return (Validation.Builder) this;
}
/**
* Initializes the value for the {@link Validation#isValid() isValid} attribute.
* @param isValid The value for isValid
* @return {@code this} builder for use in a chained invocation
*/
@CanIgnoreReturnValue
public final Validation.Builder isValid(boolean isValid) {
this.isValid = isValid;
initBits &= ~INIT_BIT_IS_VALID;
return (Validation.Builder) this;
}
/**
* Initializes the optional value {@link Validation#getMessage() message} to message.
* @param message The value for message
* @return {@code this} builder for chained invocation
*/
@CanIgnoreReturnValue
public final Validation.Builder message(String message) {
this.message = Objects.requireNonNull(message, "message");
return (Validation.Builder) this;
}
/**
* Initializes the optional value {@link Validation#getMessage() message} to message.
* @param message The value for message
* @return {@code this} builder for use in a chained invocation
*/
@CanIgnoreReturnValue
public final Validation.Builder message(Optional message) {
this.message = message.orElse(null);
return (Validation.Builder) this;
}
/**
* Builds a new {@link ImmutableValidation ImmutableValidation}.
* @return An immutable instance of Validation
* @throws java.lang.IllegalStateException if any required attributes are missing
*/
public ImmutableValidation build() {
if (initBits != 0) {
throw new IllegalStateException(formatRequiredAttributesMessage());
}
return new ImmutableValidation(isValid, message);
}
private String formatRequiredAttributesMessage() {
List attributes = Lists.newArrayList();
if ((initBits & INIT_BIT_IS_VALID) != 0) attributes.add("isValid");
return "Cannot build Validation, some of required attributes are not set " + attributes;
}
}
}