io.stargate.db.ImmutableAuthenticatedUser Maven / Gradle / Ivy
package io.stargate.db;
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import java.util.ArrayList;
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 AuthenticatedUser}.
*
* Use the builder to create immutable instances:
* {@code ImmutableAuthenticatedUser.builder()}.
*/
@Generated(from = "AuthenticatedUser", generator = "Immutables")
@SuppressWarnings({"all"})
@SuppressFBWarnings
@ParametersAreNonnullByDefault
@javax.annotation.Generated("org.immutables.processor.ProxyProcessor")
@Immutable
public final class ImmutableAuthenticatedUser implements AuthenticatedUser {
private final String name;
private ImmutableAuthenticatedUser(String name) {
this.name = name;
}
/**
* @return The value of the {@code name} attribute
*/
@Override
public String name() {
return name;
}
/**
* Copy the current immutable object by setting a value for the {@link AuthenticatedUser#name() 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 ImmutableAuthenticatedUser withName(String value) {
String newValue = Objects.requireNonNull(value, "name");
if (this.name.equals(newValue)) return this;
return new ImmutableAuthenticatedUser(newValue);
}
/**
* This instance is equal to all instances of {@code ImmutableAuthenticatedUser} 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 ImmutableAuthenticatedUser
&& equalTo((ImmutableAuthenticatedUser) another);
}
private boolean equalTo(ImmutableAuthenticatedUser another) {
return name.equals(another.name);
}
/**
* Computes a hash code from attributes: {@code name}.
* @return hashCode value
*/
@Override
public int hashCode() {
int h = 5381;
h += (h << 5) + name.hashCode();
return h;
}
/**
* Prints the immutable value {@code AuthenticatedUser} with attribute values.
* @return A string representation of the value
*/
@Override
public String toString() {
return "AuthenticatedUser{"
+ "name=" + name
+ "}";
}
/**
* Creates an immutable copy of a {@link AuthenticatedUser} 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 AuthenticatedUser instance
*/
public static ImmutableAuthenticatedUser copyOf(AuthenticatedUser instance) {
if (instance instanceof ImmutableAuthenticatedUser) {
return (ImmutableAuthenticatedUser) instance;
}
return ImmutableAuthenticatedUser.builder()
.from(instance)
.build();
}
/**
* Creates a builder for {@link ImmutableAuthenticatedUser ImmutableAuthenticatedUser}.
*
* ImmutableAuthenticatedUser.builder()
* .name(String) // required {@link AuthenticatedUser#name() name}
* .build();
*
* @return A new ImmutableAuthenticatedUser builder
*/
public static ImmutableAuthenticatedUser.Builder builder() {
return new ImmutableAuthenticatedUser.Builder();
}
/**
* Builds instances of type {@link ImmutableAuthenticatedUser ImmutableAuthenticatedUser}.
* 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 = "AuthenticatedUser", generator = "Immutables")
@NotThreadSafe
public static final class Builder {
private static final long INIT_BIT_NAME = 0x1L;
private long initBits = 0x1L;
private @Nullable String name;
private Builder() {
}
/**
* Fill a builder with attribute values from the provided {@code AuthenticatedUser} 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
*/
public final Builder from(AuthenticatedUser instance) {
Objects.requireNonNull(instance, "instance");
name(instance.name());
return this;
}
/**
* Initializes the value for the {@link AuthenticatedUser#name() name} attribute.
* @param name The value for name
* @return {@code this} builder for use in a chained invocation
*/
public final Builder name(String name) {
this.name = Objects.requireNonNull(name, "name");
initBits &= ~INIT_BIT_NAME;
return this;
}
/**
* Builds a new {@link ImmutableAuthenticatedUser ImmutableAuthenticatedUser}.
* @return An immutable instance of AuthenticatedUser
* @throws java.lang.IllegalStateException if any required attributes are missing
*/
public ImmutableAuthenticatedUser build() {
if (initBits != 0) {
throw new IllegalStateException(formatRequiredAttributesMessage());
}
return new ImmutableAuthenticatedUser(name);
}
private String formatRequiredAttributesMessage() {
List attributes = new ArrayList<>();
if ((initBits & INIT_BIT_NAME) != 0) attributes.add("name");
return "Cannot build AuthenticatedUser, some of required attributes are not set " + attributes;
}
}
}