io.github.emm035.openapi.immutables.v3.metadata.License 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 AbstractLicense}.
*
* Use the builder to create immutable instances:
* {@code License.builder()}.
* Use the static factory method to create immutable instances:
* {@code License.of()}.
*/
@SuppressWarnings({"all"})
@ParametersAreNonnullByDefault
@Immutable
@CheckReturnValue
public final class License extends AbstractLicense {
private final String name;
private final @Nullable String url;
private final ImmutableMap extensions;
private License(String name, Optional url) {
this.name = Objects.requireNonNull(name, "name");
this.url = url.orElse(null);
this.extensions = ImmutableMap.of();
}
private License(
String name,
@Nullable String url,
ImmutableMap extensions) {
this.name = name;
this.url = url;
this.extensions = extensions;
}
/**
* @return The value of the {@code name} attribute
*/
@JsonProperty("name")
@Override
public String getName() {
return name;
}
/**
* @return The value of the {@code url} attribute
*/
@JsonProperty("url")
@Override
public Optional getUrl() {
return Optional.ofNullable(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 value for the {@link AbstractLicense#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 License withName(String value) {
if (this.name.equals(value)) return this;
String newValue = Objects.requireNonNull(value, "name");
return validate(new License(newValue, this.url, this.extensions));
}
/**
* Copy the current immutable object by setting a present value for the optional {@link AbstractLicense#getUrl() url} attribute.
* @param value The value for url, {@code null} is accepted as {@code java.util.Optional.empty()}
* @return A modified copy of {@code this} object
*/
public final License withUrl(@Nullable String value) {
@Nullable String newValue = value;
if (Objects.equals(this.url, newValue)) return this;
return validate(new License(this.name, newValue, this.extensions));
}
/**
* Copy the current immutable object by setting an optional value for the {@link AbstractLicense#getUrl() url} 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 url
* @return A modified copy of {@code this} object
*/
public final License withUrl(Optional optional) {
@Nullable String value = optional.orElse(null);
if (Objects.equals(this.url, value)) return this;
return validate(new License(this.name, value, this.extensions));
}
/**
* Copy the current immutable object by replacing the {@link AbstractLicense#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 License withExtensions(Map entries) {
if (this.extensions == entries) return this;
ImmutableMap newValue = ImmutableMap.copyOf(entries);
return validate(new License(this.name, this.url, newValue));
}
/**
* This instance is equal to all instances of {@code License} 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 License
&& equalTo((License) another);
}
private boolean equalTo(License another) {
return name.equals(another.name)
&& Objects.equals(url, another.url)
&& extensions.equals(another.extensions);
}
/**
* Computes a hash code from attributes: {@code name}, {@code url}, {@code extensions}.
* @return hashCode value
*/
@Override
public int hashCode() {
int h = 5381;
h += (h << 5) + name.hashCode();
h += (h << 5) + Objects.hashCode(url);
h += (h << 5) + extensions.hashCode();
return h;
}
/**
* Prints the immutable value {@code License} with attribute values.
* @return A string representation of the value
*/
@Override
public String toString() {
return MoreObjects.toStringHelper("License")
.omitNullValues()
.add("name", name)
.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 AbstractLicense {
@Nullable String name;
@Nullable Optional url = Optional.empty();
final Map extensions = new HashMap();
@JsonProperty("name")
public void setName(String name) {
this.name = name;
}
@JsonProperty("url")
public void setUrl(Optional url) {
this.url = url;
}
@JsonAnySetter
public void setExtensions(String key, Object value) {
this.extensions.put(key, value);
}
@Override
public String getName() { throw new UnsupportedOperationException(); }
@Override
public Optional 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 License fromJson(Json json) {
License.Builder builder = License.builder();
if (json.name != null) {
builder.setName(json.name);
}
if (json.url != null) {
builder.setUrl(json.url);
}
if (json.extensions != null) {
builder.putAllExtensions(json.extensions);
}
return builder.build();
}
/**
* Construct a new immutable {@code License} instance.
* @param name The value for the {@code name} attribute
* @param url The value for the {@code url} attribute
* @return An immutable License instance
*/
public static License of(String name, Optional url) {
return validate(new License(name, url));
}
private static License validate(License instance) {
instance = (License) instance.normalizeExtensions();
return instance;
}
/**
* Creates an immutable copy of a {@link AbstractLicense} 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 License instance
*/
public static License copyOf(AbstractLicense instance) {
if (instance instanceof License) {
return (License) instance;
}
return License.builder()
.from(instance)
.build();
}
/**
* Creates a builder for {@link License License}.
* @return A new License builder
*/
public static License.Builder builder() {
return new License.Builder();
}
/**
* Builds instances of type {@link License License}.
* 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 @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.metadata.AbstractLicense} 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(AbstractLicense 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.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;
}
private void from(Object object) {
if (object instanceof AbstractLicense) {
AbstractLicense instance = (AbstractLicense) object;
setName(instance.getName());
Optional urlOptional = instance.getUrl();
if (urlOptional.isPresent()) {
setUrl(urlOptional);
}
}
if (object instanceof Extensible) {
Extensible instance = (Extensible) object;
putAllExtensions(instance.getExtensions());
}
}
/**
* Initializes the value for the {@link AbstractLicense#getName() name} attribute.
* @param name The value for name
* @return {@code this} builder for use in a chained invocation
*/
@CanIgnoreReturnValue
public final Builder setName(String name) {
this.name = Objects.requireNonNull(name, "name");
initBits &= ~INIT_BIT_NAME;
return this;
}
/**
* Initializes the optional value {@link AbstractLicense#getUrl() url} to url.
* @param url The value for url, {@code null} is accepted as {@code java.util.Optional.empty()}
* @return {@code this} builder for chained invocation
*/
@CanIgnoreReturnValue
public final Builder setUrl(@Nullable String url) {
this.url = url;
return this;
}
/**
* Initializes the optional value {@link AbstractLicense#getUrl() url} to url.
* @param url The value for url
* @return {@code this} builder for use in a chained invocation
*/
@CanIgnoreReturnValue
public final Builder setUrl(Optional url) {
this.url = url.orElse(null);
return this;
}
/**
* Put one entry to the {@link AbstractLicense#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 AbstractLicense#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 AbstractLicense#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 AbstractLicense#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 License License}.
* @return An immutable instance of License
* @throws java.lang.IllegalStateException if any required attributes are missing
*/
public License build() {
if (initBits != 0) {
throw new IllegalStateException(formatRequiredAttributesMessage());
}
return License.validate(new License(name, url, extensions.build()));
}
private String formatRequiredAttributesMessage() {
List attributes = Lists.newArrayList();
if ((initBits & INIT_BIT_NAME) != 0) attributes.add("name");
return "Cannot build License, some of required attributes are not set " + attributes;
}
}
}