io.github.emm035.openapi.immutables.v3.metadata.ExternalDocumentation Maven / Gradle / Ivy
package io.github.emm035.openapi.immutables.v3.metadata;
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.JsonProperty;
import com.google.common.base.MoreObjects;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.Lists;
import com.google.errorprone.annotations.CanIgnoreReturnValue;
import io.github.emm035.openapi.immutables.v3.shared.Extensible;
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 AbstractExternalDocumentation}.
*
* Use the builder to create immutable instances:
* {@code ExternalDocumentation.builder()}.
*/
@SuppressWarnings({"all"})
@ParametersAreNonnullByDefault
@Immutable
@CheckReturnValue
public final class ExternalDocumentation
extends AbstractExternalDocumentation {
private final @Nullable String description;
private final String url;
private final ImmutableMap extensions;
private ExternalDocumentation(
@Nullable String description,
String url,
ImmutableMap extensions) {
this.description = description;
this.url = url;
this.extensions = extensions;
}
/**
* @return The value of the {@code description} attribute
*/
@JsonProperty("description")
@Override
public Optional getDescription() {
return Optional.ofNullable(description);
}
/**
* @return The value of the {@code url} attribute
*/
@JsonProperty("url")
@Override
public String getUrl() {
return url;
}
/**
* @return The value of the {@code extensions} attribute
*/
@JsonProperty("extensions")
@JsonAnyGetter
@Override
public ImmutableMap getExtensions() {
return extensions;
}
/**
* Copy the current immutable object by setting a present value for the optional {@link AbstractExternalDocumentation#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 ExternalDocumentation withDescription(@Nullable String value) {
@Nullable String newValue = value;
if (Objects.equals(this.description, newValue)) return this;
return validate(new ExternalDocumentation(newValue, this.url, this.extensions));
}
/**
* Copy the current immutable object by setting an optional value for the {@link AbstractExternalDocumentation#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 ExternalDocumentation withDescription(Optional optional) {
@Nullable String value = optional.orElse(null);
if (Objects.equals(this.description, value)) return this;
return validate(new ExternalDocumentation(value, this.url, this.extensions));
}
/**
* Copy the current immutable object by setting a value for the {@link AbstractExternalDocumentation#getUrl() url} attribute.
* An equals check used to prevent copying of the same value by returning {@code this}.
* @param value A new value for url
* @return A modified copy of the {@code this} object
*/
public final ExternalDocumentation withUrl(String value) {
if (this.url.equals(value)) return this;
String newValue = Objects.requireNonNull(value, "url");
return validate(new ExternalDocumentation(this.description, newValue, this.extensions));
}
/**
* Copy the current immutable object by replacing the {@link AbstractExternalDocumentation#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 ExternalDocumentation withExtensions(Map entries) {
if (this.extensions == entries) return this;
ImmutableMap newValue = ImmutableMap.copyOf(entries);
return validate(new ExternalDocumentation(this.description, this.url, newValue));
}
/**
* This instance is equal to all instances of {@code ExternalDocumentation} 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 ExternalDocumentation
&& equalTo((ExternalDocumentation) another);
}
private boolean equalTo(ExternalDocumentation another) {
return Objects.equals(description, another.description)
&& url.equals(another.url)
&& extensions.equals(another.extensions);
}
/**
* Computes a hash code from attributes: {@code description}, {@code url}, {@code extensions}.
* @return hashCode value
*/
@Override
public int hashCode() {
int h = 5381;
h += (h << 5) + Objects.hashCode(description);
h += (h << 5) + url.hashCode();
h += (h << 5) + extensions.hashCode();
return h;
}
/**
* Prints the immutable value {@code ExternalDocumentation} with attribute values.
* @return A string representation of the value
*/
@Override
public String toString() {
return MoreObjects.toStringHelper("ExternalDocumentation")
.omitNullValues()
.add("description", description)
.add("url", url)
.add("extensions", extensions)
.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
@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.NONE)
static final class Json
extends AbstractExternalDocumentation {
@Nullable Optional description = Optional.empty();
@Nullable String url;
final Map extensions = new HashMap();
@JsonProperty("description")
public void setDescription(Optional description) {
this.description = description;
}
@JsonProperty("url")
public void setUrl(String url) {
this.url = url;
}
@JsonAnySetter
public void setExtensions(String key, Object value) {
this.extensions.put(key, value);
}
@Override
public Optional getDescription() { throw new UnsupportedOperationException(); }
@Override
public String getUrl() { throw new UnsupportedOperationException(); }
@Override
public Map getExtensions() { 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 ExternalDocumentation fromJson(Json json) {
ExternalDocumentation.Builder builder = ExternalDocumentation.builder();
if (json.description != null) {
builder.setDescription(json.description);
}
if (json.url != null) {
builder.setUrl(json.url);
}
if (json.extensions != null) {
builder.putAllExtensions(json.extensions);
}
return builder.build();
}
private static ExternalDocumentation validate(ExternalDocumentation instance) {
instance = (ExternalDocumentation) instance.normalizeExtensions();
return instance;
}
/**
* Creates an immutable copy of a {@link AbstractExternalDocumentation} 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 ExternalDocumentation instance
*/
public static ExternalDocumentation copyOf(AbstractExternalDocumentation instance) {
if (instance instanceof ExternalDocumentation) {
return (ExternalDocumentation) instance;
}
return ExternalDocumentation.builder()
.from(instance)
.build();
}
/**
* Creates a builder for {@link ExternalDocumentation ExternalDocumentation}.
* @return A new ExternalDocumentation builder
*/
public static ExternalDocumentation.Builder builder() {
return new ExternalDocumentation.Builder();
}
/**
* Builds instances of type {@link ExternalDocumentation ExternalDocumentation}.
* 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_URL = 0x1L;
private long initBits = 0x1L;
private @Nullable String description;
private @Nullable String url;
private ImmutableMap.Builder extensions = ImmutableMap.builder();
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.metadata.AbstractExternalDocumentation} 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(AbstractExternalDocumentation 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 AbstractExternalDocumentation) {
AbstractExternalDocumentation instance = (AbstractExternalDocumentation) object;
Optional descriptionOptional = instance.getDescription();
if (descriptionOptional.isPresent()) {
setDescription(descriptionOptional);
}
setUrl(instance.getUrl());
}
}
/**
* Initializes the optional value {@link AbstractExternalDocumentation#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 AbstractExternalDocumentation#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;
}
/**
* Initializes the value for the {@link AbstractExternalDocumentation#getUrl() url} attribute.
* @param url The value for url
* @return {@code this} builder for use in a chained invocation
*/
@CanIgnoreReturnValue
public final Builder setUrl(String url) {
this.url = Objects.requireNonNull(url, "url");
initBits &= ~INIT_BIT_URL;
return this;
}
/**
* Put one entry to the {@link AbstractExternalDocumentation#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 AbstractExternalDocumentation#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 AbstractExternalDocumentation#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 AbstractExternalDocumentation#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;
}
/**
* Builds a new {@link ExternalDocumentation ExternalDocumentation}.
* @return An immutable instance of ExternalDocumentation
* @throws java.lang.IllegalStateException if any required attributes are missing
*/
public ExternalDocumentation build() {
if (initBits != 0) {
throw new IllegalStateException(formatRequiredAttributesMessage());
}
return ExternalDocumentation.validate(new ExternalDocumentation(description, url, extensions.build()));
}
private String formatRequiredAttributesMessage() {
List attributes = Lists.newArrayList();
if ((initBits & INIT_BIT_URL) != 0) attributes.add("url");
return "Cannot build ExternalDocumentation, some of required attributes are not set " + attributes;
}
}
}