edu.isi.nlp.ImmutableToUpperCase Maven / Gradle / Ivy
package edu.isi.nlp;
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.base.Preconditions;
import com.google.common.collect.Lists;
import java.util.List;
import javax.annotation.Generated;
import javax.annotation.Nullable;
import javax.annotation.ParametersAreNonnullByDefault;
import javax.annotation.concurrent.Immutable;
import javax.annotation.concurrent.NotThreadSafe;
/**
* Immutable implementation of {@link ToUpperCase}.
*
* Use the builder to create immutable instances:
* {@code ImmutableToUpperCase.builder()}.
* Use the static factory method to create immutable instances:
* {@code ImmutableToUpperCase.of()}.
*/
@SuppressWarnings({"all"})
@ParametersAreNonnullByDefault
@Generated({"Immutables.generator", "ToUpperCase"})
@Immutable
final class ImmutableToUpperCase extends ToUpperCase {
private final NlpLocale locale;
private ImmutableToUpperCase(NlpLocale locale) {
this.locale = Preconditions.checkNotNull(locale, "locale");
}
private ImmutableToUpperCase(ImmutableToUpperCase original, NlpLocale locale) {
this.locale = locale;
}
/**
* @return The value of the {@code locale} attribute
*/
@JsonProperty("locale")
@Override
public NlpLocale locale() {
return locale;
}
/**
* Copy the current immutable object by setting a value for the {@link ToUpperCase#locale() locale} 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 locale
* @return A modified copy of the {@code this} object
*/
public final ImmutableToUpperCase withLocale(NlpLocale value) {
if (this.locale == value) return this;
NlpLocale newValue = Preconditions.checkNotNull(value, "locale");
return new ImmutableToUpperCase(this, newValue);
}
/**
* This instance is equal to all instances of {@code ImmutableToUpperCase} 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 ImmutableToUpperCase
&& equalTo((ImmutableToUpperCase) another);
}
private boolean equalTo(ImmutableToUpperCase another) {
return locale.equals(another.locale);
}
/**
* Computes a hash code from attributes: {@code locale}.
* @return hashCode value
*/
@Override
public int hashCode() {
int h = 31;
h = h * 17 + locale.hashCode();
return h;
}
/**
* Prints the immutable value {@code ToUpperCase} with attribute values.
* @return A string representation of the value
*/
@Override
public String toString() {
return MoreObjects.toStringHelper("ToUpperCase")
.omitNullValues()
.add("locale", locale)
.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 extends ToUpperCase {
@Nullable NlpLocale locale;
@JsonProperty("locale")
public void setLocale(NlpLocale locale) {
this.locale = locale;
}
@Override
public NlpLocale locale() { 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
static ImmutableToUpperCase fromJson(Json json) {
ImmutableToUpperCase.Builder builder = ImmutableToUpperCase.builder();
if (json.locale != null) {
builder.locale(json.locale);
}
return (ImmutableToUpperCase) builder.build();
}
/**
* Construct a new immutable {@code ToUpperCase} instance.
* @param locale The value for the {@code locale} attribute
* @return An immutable ToUpperCase instance
*/
public static ToUpperCase of(NlpLocale locale) {
return new ImmutableToUpperCase(locale);
}
/**
* Creates an immutable copy of a {@link ToUpperCase} 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 ToUpperCase instance
*/
public static ToUpperCase copyOf(ToUpperCase instance) {
if (instance instanceof ImmutableToUpperCase) {
return (ImmutableToUpperCase) instance;
}
return ImmutableToUpperCase.builder()
.from(instance)
.build();
}
/**
* Creates a builder for {@link ToUpperCase ToUpperCase}.
* @return A new ToUpperCase builder
*/
public static ImmutableToUpperCase.Builder builder() {
return new ImmutableToUpperCase.Builder();
}
/**
* Builds instances of type {@link ToUpperCase ToUpperCase}.
* 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
static final class Builder {
private static final long INIT_BIT_LOCALE = 0x1L;
private long initBits = 0x1L;
private @Nullable NlpLocale locale;
private Builder() {
}
/**
* Fill a builder with attribute values from the provided {@code ToUpperCase} instance.
* Regular attribute values will be replaced with those from the given instance.
* Absent optional values will not replace present values.
* @param instance The instance from which to copy values
* @return {@code this} builder for use in a chained invocation
*/
public final Builder from(ToUpperCase instance) {
Preconditions.checkNotNull(instance, "instance");
locale(instance.locale());
return this;
}
/**
* Initializes the value for the {@link ToUpperCase#locale() locale} attribute.
* @param locale The value for locale
* @return {@code this} builder for use in a chained invocation
*/
public final Builder locale(NlpLocale locale) {
this.locale = Preconditions.checkNotNull(locale, "locale");
initBits &= ~INIT_BIT_LOCALE;
return this;
}
/**
* Builds a new {@link ToUpperCase ToUpperCase}.
* @return An immutable instance of ToUpperCase
* @throws java.lang.IllegalStateException if any required attributes are missing
*/
public ToUpperCase build() {
if (initBits != 0) {
throw new IllegalStateException(formatRequiredAttributesMessage());
}
return new ImmutableToUpperCase(null, locale);
}
private String formatRequiredAttributesMessage() {
List attributes = Lists.newArrayList();
if ((initBits & INIT_BIT_LOCALE) != 0) attributes.add("locale");
return "Cannot build ToUpperCase, some of required attributes are not set " + attributes;
}
}
}