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