io.github.emm035.openapi.immutables.v3.security.SecurityRequirement Maven / Gradle / Ivy
package io.github.emm035.openapi.immutables.v3.security;
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 java.util.List;
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;
/**
* Immutable implementation of {@link SecurityRequirementIF}.
*
* Use the builder to create immutable instances:
* {@code SecurityRequirement.builder()}.
*/
@SuppressWarnings({"all"})
@ParametersAreNonnullByDefault
@Immutable
@CheckReturnValue
public final class SecurityRequirement
implements SecurityRequirementIF {
private final String name;
private final ImmutableList scopes;
private SecurityRequirement(String name, ImmutableList scopes) {
this.name = name;
this.scopes = scopes;
}
/**
* @return The value of the {@code name} attribute
*/
@JsonProperty("name")
@Override
public String getName() {
return name;
}
/**
* @return The value of the {@code scopes} attribute
*/
@JsonProperty("scopes")
@Override
public ImmutableList getScopes() {
return scopes;
}
/**
* Copy the current immutable object by setting a value for the {@link SecurityRequirementIF#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 SecurityRequirement withName(String value) {
if (this.name.equals(value)) return this;
String newValue = Objects.requireNonNull(value, "name");
return new SecurityRequirement(newValue, this.scopes);
}
/**
* Copy the current immutable object with elements that replace the content of {@link SecurityRequirementIF#getScopes() scopes}.
* @param elements The elements to set
* @return A modified copy of {@code this} object
*/
public final SecurityRequirement withScopes(String... elements) {
ImmutableList newValue = ImmutableList.copyOf(elements);
return new SecurityRequirement(this.name, newValue);
}
/**
* Copy the current immutable object with elements that replace the content of {@link SecurityRequirementIF#getScopes() scopes}.
* A shallow reference equality check is used to prevent copying of the same value by returning {@code this}.
* @param elements An iterable of scopes elements to set
* @return A modified copy of {@code this} object
*/
public final SecurityRequirement withScopes(Iterable elements) {
if (this.scopes == elements) return this;
ImmutableList newValue = ImmutableList.copyOf(elements);
return new SecurityRequirement(this.name, newValue);
}
/**
* This instance is equal to all instances of {@code SecurityRequirement} 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 SecurityRequirement
&& equalTo((SecurityRequirement) another);
}
private boolean equalTo(SecurityRequirement another) {
return name.equals(another.name)
&& scopes.equals(another.scopes);
}
/**
* Computes a hash code from attributes: {@code name}, {@code scopes}.
* @return hashCode value
*/
@Override
public int hashCode() {
int h = 5381;
h += (h << 5) + name.hashCode();
h += (h << 5) + scopes.hashCode();
return h;
}
/**
* Prints the immutable value {@code SecurityRequirement} with attribute values.
* @return A string representation of the value
*/
@Override
public String toString() {
return MoreObjects.toStringHelper("SecurityRequirement")
.omitNullValues()
.add("name", name)
.add("scopes", scopes)
.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 SecurityRequirementIF {
@Nullable String name;
@Nullable List scopes = ImmutableList.of();
@JsonProperty("name")
public void setName(String name) {
this.name = name;
}
@JsonProperty("scopes")
public void setScopes(List scopes) {
this.scopes = scopes;
}
@Override
public String getName() { throw new UnsupportedOperationException(); }
@Override
public List getScopes() { 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 SecurityRequirement fromJson(Json json) {
SecurityRequirement.Builder builder = SecurityRequirement.builder();
if (json.name != null) {
builder.setName(json.name);
}
if (json.scopes != null) {
builder.addAllScopes(json.scopes);
}
return builder.build();
}
/**
* Creates an immutable copy of a {@link SecurityRequirementIF} 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 SecurityRequirement instance
*/
public static SecurityRequirement copyOf(SecurityRequirementIF instance) {
if (instance instanceof SecurityRequirement) {
return (SecurityRequirement) instance;
}
return SecurityRequirement.builder()
.from(instance)
.build();
}
/**
* Creates a builder for {@link SecurityRequirement SecurityRequirement}.
* @return A new SecurityRequirement builder
*/
public static SecurityRequirement.Builder builder() {
return new SecurityRequirement.Builder();
}
/**
* Builds instances of type {@link SecurityRequirement SecurityRequirement}.
* 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_NAME = 0x1L;
private long initBits = 0x1L;
private @Nullable String name;
private ImmutableList.Builder scopes = ImmutableList.builder();
private Builder() {
}
/**
* Fill a builder with attribute values from the provided {@code SecurityRequirementIF} 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(SecurityRequirementIF instance) {
Objects.requireNonNull(instance, "instance");
setName(instance.getName());
addAllScopes(instance.getScopes());
return this;
}
/**
* Initializes the value for the {@link SecurityRequirementIF#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 setName(String name) {
this.name = Objects.requireNonNull(name, "name");
initBits &= ~INIT_BIT_NAME;
return this;
}
/**
* Adds one element to {@link SecurityRequirementIF#getScopes() scopes} list.
* @param element A scopes element
* @return {@code this} builder for use in a chained invocation
*/
@CanIgnoreReturnValue
public final Builder addScopes(String element) {
this.scopes.add(element);
return this;
}
/**
* Adds elements to {@link SecurityRequirementIF#getScopes() scopes} list.
* @param elements An array of scopes elements
* @return {@code this} builder for use in a chained invocation
*/
@CanIgnoreReturnValue
public final Builder addScopes(String... elements) {
this.scopes.add(elements);
return this;
}
/**
* Sets or replaces all elements for {@link SecurityRequirementIF#getScopes() scopes} list.
* @param elements An iterable of scopes elements
* @return {@code this} builder for use in a chained invocation
*/
@CanIgnoreReturnValue
@JsonProperty("scopes")
public final Builder setScopes(Iterable elements) {
this.scopes = ImmutableList.builder();
return addAllScopes(elements);
}
/**
* Adds elements to {@link SecurityRequirementIF#getScopes() scopes} list.
* @param elements An iterable of scopes elements
* @return {@code this} builder for use in a chained invocation
*/
@CanIgnoreReturnValue
public final Builder addAllScopes(Iterable elements) {
this.scopes.addAll(elements);
return this;
}
/**
* Builds a new {@link SecurityRequirement SecurityRequirement}.
* @return An immutable instance of SecurityRequirement
* @throws java.lang.IllegalStateException if any required attributes are missing
*/
public SecurityRequirement build() {
if (initBits != 0) {
throw new IllegalStateException(formatRequiredAttributesMessage());
}
return new SecurityRequirement(name, scopes.build());
}
private String formatRequiredAttributesMessage() {
List attributes = Lists.newArrayList();
if ((initBits & INIT_BIT_NAME) != 0) attributes.add("name");
return "Cannot build SecurityRequirement, some of required attributes are not set " + attributes;
}
}
}