pl.poznan.put.structure.pseudoknots.elimination.ImmutableMinGain Maven / Gradle / Ivy
package pl.poznan.put.structure.pseudoknots.elimination;
import java.util.Objects;
import javax.annotation.Nullable;
import javax.annotation.ParametersAreNonnullByDefault;
import javax.annotation.concurrent.Immutable;
import javax.annotation.concurrent.NotThreadSafe;
import org.immutables.value.Generated;
/**
* Immutable implementation of {@link MinGain}.
*
* Use the builder to create immutable instances:
* {@code ImmutableMinGain.builder()}.
* Use the static factory method to get the default singleton instance:
* {@code ImmutableMinGain.of()}.
*/
@Generated(from = "MinGain", generator = "Immutables")
@SuppressWarnings({"all"})
@ParametersAreNonnullByDefault
@javax.annotation.processing.Generated("org.immutables.processor.ProxyProcessor")
@Immutable
public final class ImmutableMinGain extends MinGain {
private ImmutableMinGain() {}
/**
* This instance is equal to all instances of {@code ImmutableMinGain} 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 ImmutableMinGain
&& equalTo((ImmutableMinGain) another);
}
@SuppressWarnings("MethodCanBeStatic")
private boolean equalTo(ImmutableMinGain another) {
return true;
}
/**
* Returns a constant hash code value.
* @return hashCode value
*/
@Override
public int hashCode() {
return 0;
}
/**
* Prints the immutable value {@code MinGain}.
* @return A string representation of the value
*/
@Override
public String toString() {
return "MinGain{}";
}
private static final ImmutableMinGain INSTANCE = validate(new ImmutableMinGain());
/**
* Returns the default immutable singleton value of {@code MinGain}
* @return An immutable instance of MinGain
*/
public static ImmutableMinGain of() {
return INSTANCE;
}
private static ImmutableMinGain validate(ImmutableMinGain instance) {
return INSTANCE != null && INSTANCE.equalTo(instance) ? INSTANCE : instance;
}
/**
* Creates an immutable copy of a {@link MinGain} 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 MinGain instance
*/
public static ImmutableMinGain copyOf(MinGain instance) {
if (instance instanceof ImmutableMinGain) {
return (ImmutableMinGain) instance;
}
return ImmutableMinGain.builder()
.from(instance)
.build();
}
/**
* Creates a builder for {@link ImmutableMinGain ImmutableMinGain}.
*
* ImmutableMinGain.builder()
* .build();
*
* @return A new ImmutableMinGain builder
*/
public static ImmutableMinGain.Builder builder() {
return new ImmutableMinGain.Builder();
}
/**
* Builds instances of type {@link ImmutableMinGain ImmutableMinGain}.
* 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.
*/
@Generated(from = "MinGain", generator = "Immutables")
@NotThreadSafe
public static final class Builder {
private Builder() {
}
/**
* Fill a builder with attribute values from the provided {@code MinGain} 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(MinGain instance) {
Objects.requireNonNull(instance, "instance");
return this;
}
/**
* Builds a new {@link ImmutableMinGain ImmutableMinGain}.
* @return An immutable instance of MinGain
* @throws java.lang.IllegalStateException if any required attributes are missing
*/
public ImmutableMinGain build() {
return ImmutableMinGain.of();
}
}
}