edu.isi.nlp.ImmutableCodepointTranslatorStringNormalizer 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 com.google.common.primitives.Chars;
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 CodepointTranslatorStringNormalizer}.
*
* Use the builder to create immutable instances:
* {@code ImmutableCodepointTranslatorStringNormalizer.builder()}.
* Use the static factory method to create immutable instances:
* {@code ImmutableCodepointTranslatorStringNormalizer.of()}.
*/
@SuppressWarnings({"all"})
@ParametersAreNonnullByDefault
@Generated({"Immutables.generator", "CodepointTranslatorStringNormalizer"})
@Immutable
final class ImmutableCodepointTranslatorStringNormalizer
extends CodepointTranslatorStringNormalizer {
private final CodepointMatcher codepointMatcher;
private final char replacementCharacter;
private ImmutableCodepointTranslatorStringNormalizer(CodepointMatcher codepointMatcher, char replacementCharacter) {
this.codepointMatcher = Preconditions.checkNotNull(codepointMatcher, "codepointMatcher");
this.replacementCharacter = replacementCharacter;
}
private ImmutableCodepointTranslatorStringNormalizer(
ImmutableCodepointTranslatorStringNormalizer original,
CodepointMatcher codepointMatcher,
char replacementCharacter) {
this.codepointMatcher = codepointMatcher;
this.replacementCharacter = replacementCharacter;
}
/**
* @return The value of the {@code codepointMatcher} attribute
*/
@JsonProperty("codepointMatcher")
@Override
public CodepointMatcher codepointMatcher() {
return codepointMatcher;
}
/**
* @return The value of the {@code replacementCharacter} attribute
*/
@JsonProperty("replacementCharacter")
@Override
public char replacementCharacter() {
return replacementCharacter;
}
/**
* Copy the current immutable object by setting a value for the {@link CodepointTranslatorStringNormalizer#codepointMatcher() codepointMatcher} 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 codepointMatcher
* @return A modified copy of the {@code this} object
*/
public final ImmutableCodepointTranslatorStringNormalizer withCodepointMatcher(CodepointMatcher value) {
if (this.codepointMatcher == value) return this;
CodepointMatcher newValue = Preconditions.checkNotNull(value, "codepointMatcher");
return new ImmutableCodepointTranslatorStringNormalizer(this, newValue, this.replacementCharacter);
}
/**
* Copy the current immutable object by setting a value for the {@link CodepointTranslatorStringNormalizer#replacementCharacter() replacementCharacter} attribute.
* A value equality check is used to prevent copying of the same value by returning {@code this}.
* @param value A new value for replacementCharacter
* @return A modified copy of the {@code this} object
*/
public final ImmutableCodepointTranslatorStringNormalizer withReplacementCharacter(char value) {
if (this.replacementCharacter == value) return this;
return new ImmutableCodepointTranslatorStringNormalizer(this, this.codepointMatcher, value);
}
/**
* This instance is equal to all instances of {@code ImmutableCodepointTranslatorStringNormalizer} 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 ImmutableCodepointTranslatorStringNormalizer
&& equalTo((ImmutableCodepointTranslatorStringNormalizer) another);
}
private boolean equalTo(ImmutableCodepointTranslatorStringNormalizer another) {
return codepointMatcher.equals(another.codepointMatcher)
&& replacementCharacter == another.replacementCharacter;
}
/**
* Computes a hash code from attributes: {@code codepointMatcher}, {@code replacementCharacter}.
* @return hashCode value
*/
@Override
public int hashCode() {
int h = 31;
h = h * 17 + codepointMatcher.hashCode();
h = h * 17 + Chars.hashCode(replacementCharacter);
return h;
}
/**
* Prints the immutable value {@code CodepointTranslatorStringNormalizer} with attribute values.
* @return A string representation of the value
*/
@Override
public String toString() {
return MoreObjects.toStringHelper("CodepointTranslatorStringNormalizer")
.omitNullValues()
.add("codepointMatcher", codepointMatcher)
.add("replacementCharacter", replacementCharacter)
.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 CodepointTranslatorStringNormalizer {
@Nullable CodepointMatcher codepointMatcher;
char replacementCharacter;
boolean replacementCharacterIsSet;
@JsonProperty("codepointMatcher")
public void setCodepointMatcher(CodepointMatcher codepointMatcher) {
this.codepointMatcher = codepointMatcher;
}
@JsonProperty("replacementCharacter")
public void setReplacementCharacter(char replacementCharacter) {
this.replacementCharacter = replacementCharacter;
this.replacementCharacterIsSet = true;
}
@Override
public CodepointMatcher codepointMatcher() { throw new UnsupportedOperationException(); }
@Override
public char replacementCharacter() { 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 ImmutableCodepointTranslatorStringNormalizer fromJson(Json json) {
ImmutableCodepointTranslatorStringNormalizer.Builder builder = ImmutableCodepointTranslatorStringNormalizer.builder();
if (json.codepointMatcher != null) {
builder.codepointMatcher(json.codepointMatcher);
}
if (json.replacementCharacterIsSet) {
builder.replacementCharacter(json.replacementCharacter);
}
return (ImmutableCodepointTranslatorStringNormalizer) builder.build();
}
/**
* Construct a new immutable {@code CodepointTranslatorStringNormalizer} instance.
* @param codepointMatcher The value for the {@code codepointMatcher} attribute
* @param replacementCharacter The value for the {@code replacementCharacter} attribute
* @return An immutable CodepointTranslatorStringNormalizer instance
*/
public static CodepointTranslatorStringNormalizer of(CodepointMatcher codepointMatcher, char replacementCharacter) {
return new ImmutableCodepointTranslatorStringNormalizer(codepointMatcher, replacementCharacter);
}
/**
* Creates an immutable copy of a {@link CodepointTranslatorStringNormalizer} 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 CodepointTranslatorStringNormalizer instance
*/
public static CodepointTranslatorStringNormalizer copyOf(CodepointTranslatorStringNormalizer instance) {
if (instance instanceof ImmutableCodepointTranslatorStringNormalizer) {
return (ImmutableCodepointTranslatorStringNormalizer) instance;
}
return ImmutableCodepointTranslatorStringNormalizer.builder()
.from(instance)
.build();
}
/**
* Creates a builder for {@link CodepointTranslatorStringNormalizer CodepointTranslatorStringNormalizer}.
* @return A new CodepointTranslatorStringNormalizer builder
*/
public static ImmutableCodepointTranslatorStringNormalizer.Builder builder() {
return new ImmutableCodepointTranslatorStringNormalizer.Builder();
}
/**
* Builds instances of type {@link CodepointTranslatorStringNormalizer CodepointTranslatorStringNormalizer}.
* 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_CODEPOINT_MATCHER = 0x1L;
private static final long INIT_BIT_REPLACEMENT_CHARACTER = 0x2L;
private long initBits = 0x3L;
private @Nullable CodepointMatcher codepointMatcher;
private char replacementCharacter;
private Builder() {
}
/**
* Fill a builder with attribute values from the provided {@code CodepointTranslatorStringNormalizer} 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(CodepointTranslatorStringNormalizer instance) {
Preconditions.checkNotNull(instance, "instance");
codepointMatcher(instance.codepointMatcher());
replacementCharacter(instance.replacementCharacter());
return this;
}
/**
* Initializes the value for the {@link CodepointTranslatorStringNormalizer#codepointMatcher() codepointMatcher} attribute.
* @param codepointMatcher The value for codepointMatcher
* @return {@code this} builder for use in a chained invocation
*/
public final Builder codepointMatcher(CodepointMatcher codepointMatcher) {
this.codepointMatcher = Preconditions.checkNotNull(codepointMatcher, "codepointMatcher");
initBits &= ~INIT_BIT_CODEPOINT_MATCHER;
return this;
}
/**
* Initializes the value for the {@link CodepointTranslatorStringNormalizer#replacementCharacter() replacementCharacter} attribute.
* @param replacementCharacter The value for replacementCharacter
* @return {@code this} builder for use in a chained invocation
*/
public final Builder replacementCharacter(char replacementCharacter) {
this.replacementCharacter = replacementCharacter;
initBits &= ~INIT_BIT_REPLACEMENT_CHARACTER;
return this;
}
/**
* Builds a new {@link CodepointTranslatorStringNormalizer CodepointTranslatorStringNormalizer}.
* @return An immutable instance of CodepointTranslatorStringNormalizer
* @throws java.lang.IllegalStateException if any required attributes are missing
*/
public CodepointTranslatorStringNormalizer build() {
if (initBits != 0) {
throw new IllegalStateException(formatRequiredAttributesMessage());
}
return new ImmutableCodepointTranslatorStringNormalizer(null, codepointMatcher, replacementCharacter);
}
private String formatRequiredAttributesMessage() {
List attributes = Lists.newArrayList();
if ((initBits & INIT_BIT_CODEPOINT_MATCHER) != 0) attributes.add("codepointMatcher");
if ((initBits & INIT_BIT_REPLACEMENT_CHARACTER) != 0) attributes.add("replacementCharacter");
return "Cannot build CodepointTranslatorStringNormalizer, some of required attributes are not set " + attributes;
}
}
}