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