Package pl.poznan.put.rna

Class ImmutableRibose

java.lang.Object

pl.poznan.put.rna.Ribose

pl.poznan.put.rna.ImmutableRibose

All Implemented Interfaces:

ResidueComponent, NucleicAcidResidueComponent

@ParametersAreNonnullByDefault
@Generated("org.immutables.processor.ProxyProcessor")
@Immutable
public final class ImmutableRibose
extends Ribose

Immutable implementation of Ribose.

Use the builder to create immutable instances: ImmutableRibose.builder(). Use the static factory method to get the default singleton instance: ImmutableRibose.of().

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ImmutableRibose.Builder	Builds instances of type ImmutableRibose.

Method Summary

Modifier and Type	Method	Description
static ImmutableRibose.Builder	builder()	Creates a builder for ImmutableRibose.
static ImmutableRibose	copyOf(Ribose instance)	Creates an immutable copy of a Ribose value.
boolean	equals(Object another)	This instance is equal to all instances of ImmutableRibose that have equal attribute values.
int	hashCode()	Returns a constant hash code value.
default NucleotideComponentType	nucleotideComponentType()
static ImmutableRibose	of()	Returns the default immutable singleton value of Ribose
String	toString()	Prints the immutable value Ribose.

Methods inherited from class pl.poznan.put.rna.Ribose

requiredAtoms

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface pl.poznan.put.pdb.analysis.ResidueComponent

additionalAtoms

Method Detail

equals

public boolean equals(@Nullable
                      Object another)

This instance is equal to all instances of ImmutableRibose that have equal attribute values.

Overrides:

equals in class Object

Returns:

true if this is equal to another instance

hashCode

public int hashCode()

Returns a constant hash code value.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value Ribose.

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static ImmutableRibose of()

Returns the default immutable singleton value of Ribose

Returns:

An immutable instance of Ribose

copyOf

public static ImmutableRibose copyOf(Ribose instance)

Creates an immutable copy of a Ribose value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.

Parameters:

instance - The instance to copy

Returns:

A copied immutable Ribose instance

builder

public static ImmutableRibose.Builder builder()

Creates a builder for ImmutableRibose.

 ImmutableRibose.builder()
    .build();
 

Returns:

A new ImmutableRibose builder

nucleotideComponentType

public default NucleotideComponentType nucleotideComponentType()

Specified by:

nucleotideComponentType in interface NucleicAcidResidueComponent

Returns:

The type of this nucleotide component.