io.stargate.db.ImmutableAuthenticatedUser Maven / Gradle / Ivy
package io.stargate.db;
import com.google.errorprone.annotations.CanIgnoreReturnValue;
import com.google.errorprone.annotations.Var;
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import java.util.ArrayList;
import java.util.Collections;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import javax.annotation.CheckReturnValue;
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
@CheckReturnValue
public final class ImmutableAuthenticatedUser implements AuthenticatedUser {
private final String name;
private final @Nullable String token;
private final boolean isFromExternalAuth;
private final Map customProperties;
private ImmutableAuthenticatedUser(
String name,
@Nullable String token,
boolean isFromExternalAuth,
Map customProperties) {
this.name = name;
this.token = token;
this.isFromExternalAuth = isFromExternalAuth;
this.customProperties = customProperties;
}
/**
* @return The value of the {@code name} attribute
*/
@Override
public String name() {
return name;
}
/**
* @return The value of the {@code token} attribute
*/
@Override
public @Nullable String token() {
return token;
}
/**
* @return The value of the {@code isFromExternalAuth} attribute
*/
@Override
public boolean isFromExternalAuth() {
return isFromExternalAuth;
}
/**
* @return The value of the {@code customProperties} attribute
*/
@Override
public Map customProperties() {
return customProperties;
}
/**
* 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.token, this.isFromExternalAuth, this.customProperties);
}
/**
* Copy the current immutable object by setting a value for the {@link AuthenticatedUser#token() token} attribute.
* An equals check used to prevent copying of the same value by returning {@code this}.
* @param value A new value for token (can be {@code null})
* @return A modified copy of the {@code this} object
*/
public final ImmutableAuthenticatedUser withToken(@Nullable String value) {
if (Objects.equals(this.token, value)) return this;
return new ImmutableAuthenticatedUser(this.name, value, this.isFromExternalAuth, this.customProperties);
}
/**
* Copy the current immutable object by setting a value for the {@link AuthenticatedUser#isFromExternalAuth() isFromExternalAuth} attribute.
* A value equality check is used to prevent copying of the same value by returning {@code this}.
* @param value A new value for isFromExternalAuth
* @return A modified copy of the {@code this} object
*/
public final ImmutableAuthenticatedUser withIsFromExternalAuth(boolean value) {
if (this.isFromExternalAuth == value) return this;
return new ImmutableAuthenticatedUser(this.name, this.token, value, this.customProperties);
}
/**
* Copy the current immutable object by replacing the {@link AuthenticatedUser#customProperties() customProperties} map with the specified map.
* Nulls are not permitted as keys or values.
* A shallow reference equality check is used to prevent copying of the same value by returning {@code this}.
* @param entries The entries to be added to the customProperties map
* @return A modified copy of {@code this} object
*/
public final ImmutableAuthenticatedUser withCustomProperties(Map entries) {
if (this.customProperties == entries) return this;
Map newValue = createUnmodifiableMap(true, false, entries);
return new ImmutableAuthenticatedUser(this.name, this.token, this.isFromExternalAuth, 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)
&& Objects.equals(token, another.token)
&& isFromExternalAuth == another.isFromExternalAuth
&& customProperties.equals(another.customProperties);
}
/**
* Computes a hash code from attributes: {@code name}, {@code token}, {@code isFromExternalAuth}, {@code customProperties}.
* @return hashCode value
*/
@Override
public int hashCode() {
@Var int h = 5381;
h += (h << 5) + name.hashCode();
h += (h << 5) + Objects.hashCode(token);
h += (h << 5) + Boolean.hashCode(isFromExternalAuth);
h += (h << 5) + customProperties.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
+ ", token=" + token
+ ", isFromExternalAuth=" + isFromExternalAuth
+ ", customProperties=" + customProperties
+ "}";
}
/**
* 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}
* .token(String | null) // nullable {@link AuthenticatedUser#token() token}
* .isFromExternalAuth(boolean) // required {@link AuthenticatedUser#isFromExternalAuth() isFromExternalAuth}
* .putCustomProperties|putAllCustomProperties(String => String) // {@link AuthenticatedUser#customProperties() customProperties} mappings
* .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 static final long INIT_BIT_IS_FROM_EXTERNAL_AUTH = 0x2L;
private long initBits = 0x3L;
private @Nullable String name;
private @Nullable String token;
private boolean isFromExternalAuth;
private Map customProperties = new LinkedHashMap();
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.
* Collection elements and entries will be added, not replaced.
* @param instance The instance from which to copy values
* @return {@code this} builder for use in a chained invocation
*/
@CanIgnoreReturnValue
public final Builder from(AuthenticatedUser instance) {
Objects.requireNonNull(instance, "instance");
name(instance.name());
@Nullable String tokenValue = instance.token();
if (tokenValue != null) {
token(tokenValue);
}
isFromExternalAuth(instance.isFromExternalAuth());
putAllCustomProperties(instance.customProperties());
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
*/
@CanIgnoreReturnValue
public final Builder name(String name) {
this.name = Objects.requireNonNull(name, "name");
initBits &= ~INIT_BIT_NAME;
return this;
}
/**
* Initializes the value for the {@link AuthenticatedUser#token() token} attribute.
* @param token The value for token (can be {@code null})
* @return {@code this} builder for use in a chained invocation
*/
@CanIgnoreReturnValue
public final Builder token(@Nullable String token) {
this.token = token;
return this;
}
/**
* Initializes the value for the {@link AuthenticatedUser#isFromExternalAuth() isFromExternalAuth} attribute.
* @param isFromExternalAuth The value for isFromExternalAuth
* @return {@code this} builder for use in a chained invocation
*/
@CanIgnoreReturnValue
public final Builder isFromExternalAuth(boolean isFromExternalAuth) {
this.isFromExternalAuth = isFromExternalAuth;
initBits &= ~INIT_BIT_IS_FROM_EXTERNAL_AUTH;
return this;
}
/**
* Put one entry to the {@link AuthenticatedUser#customProperties() customProperties} map.
* @param key The key in the customProperties map
* @param value The associated value in the customProperties map
* @return {@code this} builder for use in a chained invocation
*/
@CanIgnoreReturnValue
public final Builder putCustomProperties(String key, String value) {
this.customProperties.put(
Objects.requireNonNull(key, "customProperties key"),
Objects.requireNonNull(value, "customProperties value"));
return this;
}
/**
* Put one entry to the {@link AuthenticatedUser#customProperties() customProperties} map. Nulls are not permitted
* @param entry The key and value entry
* @return {@code this} builder for use in a chained invocation
*/
@CanIgnoreReturnValue
public final Builder putCustomProperties(Map.Entry entry) {
String k = entry.getKey();
String v = entry.getValue();
this.customProperties.put(
Objects.requireNonNull(k, "customProperties key"),
Objects.requireNonNull(v, "customProperties value"));
return this;
}
/**
* Sets or replaces all mappings from the specified map as entries for the {@link AuthenticatedUser#customProperties() customProperties} map. Nulls are not permitted
* @param entries The entries that will be added to the customProperties map
* @return {@code this} builder for use in a chained invocation
*/
@CanIgnoreReturnValue
public final Builder customProperties(Map entries) {
this.customProperties.clear();
return putAllCustomProperties(entries);
}
/**
* Put all mappings from the specified map as entries to {@link AuthenticatedUser#customProperties() customProperties} map. Nulls are not permitted
* @param entries The entries that will be added to the customProperties map
* @return {@code this} builder for use in a chained invocation
*/
@CanIgnoreReturnValue
public final Builder putAllCustomProperties(Map entries) {
for (Map.Entry e : entries.entrySet()) {
String k = e.getKey();
String v = e.getValue();
this.customProperties.put(
Objects.requireNonNull(k, "customProperties key"),
Objects.requireNonNull(v, "customProperties value"));
}
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, token, isFromExternalAuth, createUnmodifiableMap(false, false, customProperties));
}
private String formatRequiredAttributesMessage() {
List attributes = new ArrayList<>();
if ((initBits & INIT_BIT_NAME) != 0) attributes.add("name");
if ((initBits & INIT_BIT_IS_FROM_EXTERNAL_AUTH) != 0) attributes.add("isFromExternalAuth");
return "Cannot build AuthenticatedUser, some of required attributes are not set " + attributes;
}
}
private static Map createUnmodifiableMap(boolean checkNulls, boolean skipNulls, Map map) {
switch (map.size()) {
case 0: return Collections.emptyMap();
case 1: {
Map.Entry e = map.entrySet().iterator().next();
K k = e.getKey();
V v = e.getValue();
if (checkNulls) {
Objects.requireNonNull(k, "key");
Objects.requireNonNull(v, "value");
}
if (skipNulls && (k == null || v == null)) {
return Collections.emptyMap();
}
return Collections.singletonMap(k, v);
}
default: {
Map linkedMap = new LinkedHashMap<>(map.size());
if (skipNulls || checkNulls) {
for (Map.Entry e : map.entrySet()) {
K k = e.getKey();
V v = e.getValue();
if (skipNulls) {
if (k == null || v == null) continue;
} else if (checkNulls) {
Objects.requireNonNull(k, "key");
Objects.requireNonNull(v, "value");
}
linkedMap.put(k, v);
}
} else {
linkedMap.putAll(map);
}
return Collections.unmodifiableMap(linkedMap);
}
}
}
}