Package pl.poznan.put.torsion

Class ImmutableAverageTorsionAngleType

java.lang.Object

pl.poznan.put.torsion.AverageTorsionAngleType

pl.poznan.put.torsion.ImmutableAverageTorsionAngleType

All Implemented Interfaces:

DisplayableExportable, MasterTorsionAngleType, TorsionAngleType

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

Immutable implementation of AverageTorsionAngleType.

Use the builder to create immutable instances: ImmutableAverageTorsionAngleType.builder(). Use the static factory method to create immutable instances: ImmutableAverageTorsionAngleType.of().

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ImmutableAverageTorsionAngleType.Builder	builder()	Creates a builder for ImmutableAverageTorsionAngleType.
List<MasterTorsionAngleType>	consideredAngles()
protected Set<TorsionAngleType>	consideredBasicAngleTypes()
static ImmutableAverageTorsionAngleType	copyOf(AverageTorsionAngleType instance)	Creates an immutable copy of a AverageTorsionAngleType value.
boolean	equals(Object another)	This instance is equal to all instances of ImmutableAverageTorsionAngleType that have equal attribute values.
String	exportName()
int	hashCode()	Computes a hash code from attributes: moleculeType, consideredAngles.
MoleculeType	moleculeType()
static ImmutableAverageTorsionAngleType	of(MoleculeType moleculeType, Iterable<? extends MasterTorsionAngleType> consideredAngles)	Construct a new immutable AverageTorsionAngleType instance.
static ImmutableAverageTorsionAngleType	of(MoleculeType moleculeType, List<MasterTorsionAngleType> consideredAngles)	Construct a new immutable AverageTorsionAngleType instance.
String	shortDisplayName()
String	toString()	Prints the immutable value AverageTorsionAngleType with attribute values.
ImmutableAverageTorsionAngleType	withConsideredAngles(Iterable<? extends MasterTorsionAngleType> elements)	Copy the current immutable object with elements that replace the content of consideredAngles.
ImmutableAverageTorsionAngleType	withConsideredAngles(MasterTorsionAngleType... elements)	Copy the current immutable object with elements that replace the content of consideredAngles.
ImmutableAverageTorsionAngleType	withMoleculeType(MoleculeType value)	Copy the current immutable object by setting a value for the moleculeType attribute.

Methods inherited from class pl.poznan.put.torsion.AverageTorsionAngleType

angleTypes, calculate, calculate, forNucleicAcid, forProtein, longDisplayName, range

Methods inherited from class java.lang.Object

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

Method Detail

moleculeType

public MoleculeType moleculeType()

Specified by:

moleculeType in interface TorsionAngleType

Specified by:

moleculeType in class AverageTorsionAngleType

Returns:

The value of the moleculeType attribute

consideredAngles

public List<MasterTorsionAngleType> consideredAngles()

Specified by:

consideredAngles in class AverageTorsionAngleType

Returns:

The list of angle types to calculate average from.

withMoleculeType

public final ImmutableAverageTorsionAngleType withMoleculeType(MoleculeType value)

Copy the current immutable object by setting a value for the moleculeType attribute. A value equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for moleculeType

Returns:

A modified copy of the this object

withConsideredAngles

public final ImmutableAverageTorsionAngleType withConsideredAngles(MasterTorsionAngleType... elements)

Copy the current immutable object with elements that replace the content of consideredAngles.

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withConsideredAngles

public final ImmutableAverageTorsionAngleType withConsideredAngles(Iterable<? extends MasterTorsionAngleType> elements)

Copy the current immutable object with elements that replace the content of consideredAngles. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

elements - An iterable of consideredAngles elements to set

Returns:

A modified copy of this object

equals

public boolean equals(@Nullable
                      Object another)

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

Overrides:

equals in class Object

Returns:

true if this is equal to another instance

hashCode

public int hashCode()

Computes a hash code from attributes: moleculeType, consideredAngles.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value AverageTorsionAngleType with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

shortDisplayName

public String shortDisplayName()

Returns a lazily initialized value of the shortDisplayName attribute. Initialized once and only once and stored for subsequent access with proper synchronization. In case of any exception or error thrown by the lazy value initializer, the result will not be memoised (i.e. remembered) and on next call computation will be attempted again.

Specified by:

shortDisplayName in interface DisplayableExportable

Overrides:

shortDisplayName in class AverageTorsionAngleType

Returns:

A lazily initialized value of the shortDisplayName attribute

exportName

public String exportName()

Returns a lazily initialized value of the exportName attribute. Initialized once and only once and stored for subsequent access with proper synchronization. In case of any exception or error thrown by the lazy value initializer, the result will not be memoised (i.e. remembered) and on next call computation will be attempted again.

Specified by:

exportName in interface DisplayableExportable

Overrides:

exportName in class AverageTorsionAngleType

Returns:

A lazily initialized value of the exportName attribute

consideredBasicAngleTypes

protected Set<TorsionAngleType> consideredBasicAngleTypes()

Returns a lazily initialized value of the consideredBasicAngleTypes attribute. Initialized once and only once and stored for subsequent access with proper synchronization. In case of any exception or error thrown by the lazy value initializer, the result will not be memoised (i.e. remembered) and on next call computation will be attempted again.

Overrides:

consideredBasicAngleTypes in class AverageTorsionAngleType

Returns:

A lazily initialized value of the consideredBasicAngleTypes attribute

of

public static ImmutableAverageTorsionAngleType of(MoleculeType moleculeType,
                                                  List<MasterTorsionAngleType> consideredAngles)

Construct a new immutable AverageTorsionAngleType instance.

Parameters:

moleculeType - The value for the moleculeType attribute

consideredAngles - The value for the consideredAngles attribute

Returns:

An immutable AverageTorsionAngleType instance

of

public static ImmutableAverageTorsionAngleType of(MoleculeType moleculeType,
                                                  Iterable<? extends MasterTorsionAngleType> consideredAngles)

Construct a new immutable AverageTorsionAngleType instance.

Parameters:

moleculeType - The value for the moleculeType attribute

consideredAngles - The value for the consideredAngles attribute

Returns:

An immutable AverageTorsionAngleType instance

copyOf

public static ImmutableAverageTorsionAngleType copyOf(AverageTorsionAngleType instance)

Creates an immutable copy of a AverageTorsionAngleType 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 AverageTorsionAngleType instance

builder

public static ImmutableAverageTorsionAngleType.Builder builder()

Creates a builder for ImmutableAverageTorsionAngleType.

 ImmutableAverageTorsionAngleType.builder()
    .moleculeType(pl.poznan.put.pdb.analysis.MoleculeType) // required moleculeType
    .addConsideredAngles|addAllConsideredAngles(pl.poznan.put.torsion.MasterTorsionAngleType) // consideredAngles elements
    .build();
 

Returns:

A new ImmutableAverageTorsionAngleType builder