io.github.emm035.openapi.immutables.v3.security.OAuth2Scheme Maven / Gradle / Ivy
Show all versions of openapi-immutables Show documentation
package io.github.emm035.openapi.immutables.v3.security;
import com.fasterxml.jackson.annotation.JsonAnyGetter;
import com.fasterxml.jackson.annotation.JsonAnySetter;
import com.fasterxml.jackson.annotation.JsonAutoDetect;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonTypeInfo;
import com.google.common.base.MoreObjects;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.Lists;
import com.google.common.primitives.Booleans;
import com.google.errorprone.annotations.CanIgnoreReturnValue;
import io.github.emm035.openapi.immutables.v3.security.flows.Flows;
import io.github.emm035.openapi.immutables.v3.shared.Describable;
import io.github.emm035.openapi.immutables.v3.shared.Extensible;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
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 AbstractOAuth2Scheme}.
*
* Use the builder to create immutable instances:
* {@code OAuth2Scheme.builder()}.
*/
@SuppressWarnings({"all"})
@ParametersAreNonnullByDefault
@Immutable
@CheckReturnValue
public final class OAuth2Scheme extends AbstractOAuth2Scheme {
private final SecurityScheme.Type type;
private final Flows flows;
private final ImmutableMap extensions;
private final @Nullable String description;
private final boolean referential;
private OAuth2Scheme(
Flows flows,
ImmutableMap extensions,
@Nullable String description) {
this.flows = flows;
this.extensions = extensions;
this.description = description;
this.type = initShim.getType();
this.referential = initShim.isReferential();
this.initShim = null;
}
private static final int STAGE_INITIALIZING = -1;
private static final int STAGE_UNINITIALIZED = 0;
private static final int STAGE_INITIALIZED = 1;
private transient volatile InitShim initShim = new InitShim();
private final class InitShim {
private SecurityScheme.Type type;
private int typeBuildStage;
SecurityScheme.Type getType() {
if (typeBuildStage == STAGE_INITIALIZING) throw new IllegalStateException(formatInitCycleMessage());
if (typeBuildStage == STAGE_UNINITIALIZED) {
typeBuildStage = STAGE_INITIALIZING;
this.type = Objects.requireNonNull(OAuth2Scheme.super.getType(), "type");
typeBuildStage = STAGE_INITIALIZED;
}
return this.type;
}
private boolean referential;
private int referentialBuildStage;
boolean isReferential() {
if (referentialBuildStage == STAGE_INITIALIZING) throw new IllegalStateException(formatInitCycleMessage());
if (referentialBuildStage == STAGE_UNINITIALIZED) {
referentialBuildStage = STAGE_INITIALIZING;
this.referential = OAuth2Scheme.super.isReferential();
referentialBuildStage = STAGE_INITIALIZED;
}
return this.referential;
}
private String formatInitCycleMessage() {
ArrayList attributes = Lists.newArrayList();
if (typeBuildStage == STAGE_INITIALIZING) attributes.add("type");
if (referentialBuildStage == STAGE_INITIALIZING) attributes.add("referential");
return "Cannot build OAuth2Scheme, attribute initializers form cycle" + attributes;
}
}
/**
* @return The computed-at-construction value of the {@code type} attribute
*/
@JsonProperty("type")
@Override
public SecurityScheme.Type getType() {
InitShim shim = this.initShim;
return shim != null
? shim.getType()
: this.type;
}
/**
* @return The value of the {@code flows} attribute
*/
@JsonProperty("flows")
@Override
public Flows getFlows() {
return flows;
}
/**
* @return The value of the {@code extensions} attribute
*/
@JsonProperty("extensions")
@JsonAnyGetter
@Override
public ImmutableMap getExtensions() {
return extensions;
}
/**
* @return The value of the {@code description} attribute
*/
@JsonProperty("description")
@Override
public Optional getDescription() {
return Optional.ofNullable(description);
}
/**
* @return The computed-at-construction value of the {@code referential} attribute
*/
@JsonProperty("referential")
@JsonIgnore
@Override
public boolean isReferential() {
InitShim shim = this.initShim;
return shim != null
? shim.isReferential()
: this.referential;
}
/**
* Copy the current immutable object by setting a value for the {@link AbstractOAuth2Scheme#getFlows() flows} attribute.
* A shallow reference equality check is used to prevent copying of the same value by returning {@code this}.
* @param value A new value for flows
* @return A modified copy of the {@code this} object
*/
public final OAuth2Scheme withFlows(Flows value) {
if (this.flows == value) return this;
Flows newValue = Objects.requireNonNull(value, "flows");
return new OAuth2Scheme(newValue, this.extensions, this.description);
}
/**
* Copy the current immutable object by replacing the {@link AbstractOAuth2Scheme#getExtensions() extensions} 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 extensions map
* @return A modified copy of {@code this} object
*/
public final OAuth2Scheme withExtensions(Map entries) {
if (this.extensions == entries) return this;
ImmutableMap newValue = ImmutableMap.copyOf(entries);
return new OAuth2Scheme(this.flows, newValue, this.description);
}
/**
* Copy the current immutable object by setting a present value for the optional {@link AbstractOAuth2Scheme#getDescription() description} attribute.
* @param value The value for description, {@code null} is accepted as {@code java.util.Optional.empty()}
* @return A modified copy of {@code this} object
*/
public final OAuth2Scheme withDescription(@Nullable String value) {
@Nullable String newValue = value;
if (Objects.equals(this.description, newValue)) return this;
return new OAuth2Scheme(this.flows, this.extensions, newValue);
}
/**
* Copy the current immutable object by setting an optional value for the {@link AbstractOAuth2Scheme#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 OAuth2Scheme withDescription(Optional optional) {
@Nullable String value = optional.orElse(null);
if (Objects.equals(this.description, value)) return this;
return new OAuth2Scheme(this.flows, this.extensions, value);
}
/**
* This instance is equal to all instances of {@code OAuth2Scheme} 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 OAuth2Scheme
&& equalTo((OAuth2Scheme) another);
}
private boolean equalTo(OAuth2Scheme another) {
return type.equals(another.type)
&& flows.equals(another.flows)
&& extensions.equals(another.extensions)
&& Objects.equals(description, another.description)
&& referential == another.referential;
}
/**
* Computes a hash code from attributes: {@code type}, {@code flows}, {@code extensions}, {@code description}, {@code referential}.
* @return hashCode value
*/
@Override
public int hashCode() {
int h = 5381;
h += (h << 5) + type.hashCode();
h += (h << 5) + flows.hashCode();
h += (h << 5) + extensions.hashCode();
h += (h << 5) + Objects.hashCode(description);
h += (h << 5) + Booleans.hashCode(referential);
return h;
}
/**
* Prints the immutable value {@code OAuth2Scheme} with attribute values.
* @return A string representation of the value
*/
@Override
public String toString() {
return MoreObjects.toStringHelper("OAuth2Scheme")
.omitNullValues()
.add("type", type)
.add("flows", flows)
.add("extensions", extensions)
.add("description", description)
.add("referential", referential)
.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
@JsonTypeInfo(use=JsonTypeInfo.Id.NONE)
@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.NONE)
static final class Json extends AbstractOAuth2Scheme {
@Nullable Flows flows;
@Nullable Optional description = Optional.empty();
final Map extensions = new HashMap();
@JsonProperty("flows")
public void setFlows(Flows flows) {
this.flows = flows;
}
@JsonProperty("description")
public void setDescription(Optional description) {
this.description = description;
}
@JsonAnySetter
public void setExtensions(String key, Object value) {
this.extensions.put(key, value);
}
@Override
public SecurityScheme.Type getType() { throw new UnsupportedOperationException(); }
@Override
public Flows getFlows() { throw new UnsupportedOperationException(); }
@Override
public Map getExtensions() { throw new UnsupportedOperationException(); }
@Override
public Optional getDescription() { throw new UnsupportedOperationException(); }
@Override
public boolean isReferential() { 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 OAuth2Scheme fromJson(Json json) {
OAuth2Scheme.Builder builder = OAuth2Scheme.builder();
if (json.flows != null) {
builder.setFlows(json.flows);
}
if (json.extensions != null) {
builder.putAllExtensions(json.extensions);
}
if (json.description != null) {
builder.setDescription(json.description);
}
return builder.build();
}
/**
* Creates an immutable copy of a {@link AbstractOAuth2Scheme} 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 OAuth2Scheme instance
*/
public static OAuth2Scheme copyOf(AbstractOAuth2Scheme instance) {
if (instance instanceof OAuth2Scheme) {
return (OAuth2Scheme) instance;
}
return OAuth2Scheme.builder()
.from(instance)
.build();
}
/**
* Creates a builder for {@link OAuth2Scheme OAuth2Scheme}.
* @return A new OAuth2Scheme builder
*/
public static OAuth2Scheme.Builder builder() {
return new OAuth2Scheme.Builder();
}
/**
* Builds instances of type {@link OAuth2Scheme OAuth2Scheme}.
* 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_FLOWS = 0x1L;
private long initBits = 0x1L;
private @Nullable Flows flows;
private ImmutableMap.Builder extensions = ImmutableMap.builder();
private @Nullable String description;
private Builder() {
}
/**
* Fill a builder with attribute values from the provided {@code io.github.emm035.openapi.immutables.v3.shared.Extensible} 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(Extensible instance) {
Objects.requireNonNull(instance, "instance");
from((Object) instance);
return this;
}
/**
* Fill a builder with attribute values from the provided {@code io.github.emm035.openapi.immutables.v3.security.AbstractOAuth2Scheme} 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(AbstractOAuth2Scheme instance) {
Objects.requireNonNull(instance, "instance");
from((Object) instance);
return this;
}
/**
* Fill a builder with attribute values from the provided {@code io.github.emm035.openapi.immutables.v3.shared.Describable} 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(Describable instance) {
Objects.requireNonNull(instance, "instance");
from((Object) instance);
return this;
}
private void from(Object object) {
if (object instanceof Extensible) {
Extensible instance = (Extensible) object;
putAllExtensions(instance.getExtensions());
}
if (object instanceof AbstractOAuth2Scheme) {
AbstractOAuth2Scheme instance = (AbstractOAuth2Scheme) object;
setFlows(instance.getFlows());
}
if (object instanceof Describable) {
Describable instance = (Describable) object;
Optional descriptionOptional = instance.getDescription();
if (descriptionOptional.isPresent()) {
setDescription(descriptionOptional);
}
}
}
/**
* Initializes the value for the {@link AbstractOAuth2Scheme#getFlows() flows} attribute.
* @param flows The value for flows
* @return {@code this} builder for use in a chained invocation
*/
@CanIgnoreReturnValue
public final Builder setFlows(Flows flows) {
this.flows = Objects.requireNonNull(flows, "flows");
initBits &= ~INIT_BIT_FLOWS;
return this;
}
/**
* Put one entry to the {@link AbstractOAuth2Scheme#getExtensions() extensions} map.
* @param key The key in the extensions map
* @param value The associated value in the extensions map
* @return {@code this} builder for use in a chained invocation
*/
@CanIgnoreReturnValue
@JsonAnySetter
public final Builder putExtensions(String key, Object value) {
this.extensions.put(key, value);
return this;
}
/**
* Put one entry to the {@link AbstractOAuth2Scheme#getExtensions() extensions} 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 putExtensions(Map.Entry entry) {
this.extensions.put(entry);
return this;
}
/**
* Sets or replaces all mappings from the specified map as entries for the {@link AbstractOAuth2Scheme#getExtensions() extensions} map. Nulls are not permitted
* @param extensions The entries that will be added to the extensions map
* @return {@code this} builder for use in a chained invocation
*/
@CanIgnoreReturnValue
public final Builder setExtensions(Map extensions) {
this.extensions = ImmutableMap.builder();
return putAllExtensions(extensions);
}
/**
* Put all mappings from the specified map as entries to {@link AbstractOAuth2Scheme#getExtensions() extensions} map. Nulls are not permitted
* @param extensions The entries that will be added to the extensions map
* @return {@code this} builder for use in a chained invocation
*/
@CanIgnoreReturnValue
public final Builder putAllExtensions(Map extensions) {
this.extensions.putAll(extensions);
return this;
}
/**
* Initializes the optional value {@link AbstractOAuth2Scheme#getDescription() description} to description.
* @param description The value for description, {@code null} is accepted as {@code java.util.Optional.empty()}
* @return {@code this} builder for chained invocation
*/
@CanIgnoreReturnValue
public final Builder setDescription(@Nullable String description) {
this.description = description;
return this;
}
/**
* Initializes the optional value {@link AbstractOAuth2Scheme#getDescription() description} to description.
* @param description The value for description
* @return {@code this} builder for use in a chained invocation
*/
@CanIgnoreReturnValue
public final Builder setDescription(Optional description) {
this.description = description.orElse(null);
return this;
}
/**
* Builds a new {@link OAuth2Scheme OAuth2Scheme}.
* @return An immutable instance of OAuth2Scheme
* @throws java.lang.IllegalStateException if any required attributes are missing
*/
public OAuth2Scheme build() {
if (initBits != 0) {
throw new IllegalStateException(formatRequiredAttributesMessage());
}
return new OAuth2Scheme(flows, extensions.build(), description);
}
private String formatRequiredAttributesMessage() {
List attributes = Lists.newArrayList();
if ((initBits & INIT_BIT_FLOWS) != 0) attributes.add("flows");
return "Cannot build OAuth2Scheme, some of required attributes are not set " + attributes;
}
}
}