java.lang.Object
- pl.poznan.put.torsion.ImmutableAtomBasedTorsionAngleType

All Implemented Interfaces:

DisplayableExportable, AtomBasedTorsionAngleType, TorsionAngleType
```
@ParametersAreNonnullByDefault
@Generated("org.immutables.processor.ProxyProcessor")
@Immutable
public final class ImmutableAtomBasedTorsionAngleType
extends Object
implements AtomBasedTorsionAngleType
```
Immutable implementation of AtomBasedTorsionAngleType.
Use the builder to create immutable instances: ImmutableAtomBasedTorsionAngleType.builder(). Use the static factory method to create immutable instances: ImmutableAtomBasedTorsionAngleType.of().

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class ImmutableAtomBasedTorsionAngleType.Builder
Builds instances of type ImmutableAtomBasedTorsionAngleType.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Quadruple<AtomName>`	`atoms()`
`static ImmutableAtomBasedTorsionAngleType.Builder`	`builder()`	Creates a builder for `ImmutableAtomBasedTorsionAngleType`.
`static ImmutableAtomBasedTorsionAngleType`	`copyOf(AtomBasedTorsionAngleType instance)`	Creates an immutable copy of a `AtomBasedTorsionAngleType` value.
`boolean`	`equals(Object another)`	This instance is equal to all instances of `ImmutableAtomBasedTorsionAngleType` that have equal attribute values.
`String`	`exportName()`
`int`	`hashCode()`	Computes a hash code from attributes: `moleculeType`, `shortDisplayName`, `exportName`, `atoms`, `residueRule`, `isPseudoTorsion`.
`boolean`	`isPseudoTorsion()`
`MoleculeType`	`moleculeType()`
`static ImmutableAtomBasedTorsionAngleType`	`of(MoleculeType moleculeType, String shortDisplayName, String exportName, Quadruple<AtomName> atoms, Quadruple<Integer> residueRule)`	Construct a new immutable `AtomBasedTorsionAngleType` instance.
`Quadruple<Integer>`	`residueRule()`
`String`	`shortDisplayName()`
`String`	`toString()`	Prints the immutable value `AtomBasedTorsionAngleType` with attribute values.
`ImmutableAtomBasedTorsionAngleType`	`withAtoms(Quadruple<AtomName> value)`	Copy the current immutable object by setting a value for the `atoms` attribute.
`ImmutableAtomBasedTorsionAngleType`	`withExportName(String value)`	Copy the current immutable object by setting a value for the `exportName` attribute.
`ImmutableAtomBasedTorsionAngleType`	`withIsPseudoTorsion(boolean value)`	Copy the current immutable object by setting a value for the `isPseudoTorsion` attribute.
`ImmutableAtomBasedTorsionAngleType`	`withMoleculeType(MoleculeType value)`	Copy the current immutable object by setting a value for the `moleculeType` attribute.
`ImmutableAtomBasedTorsionAngleType`	`withResidueRule(Quadruple<Integer> value)`	Copy the current immutable object by setting a value for the `residueRule` attribute.
`ImmutableAtomBasedTorsionAngleType`	`withShortDisplayName(String value)`	Copy the current immutable object by setting a value for the `shortDisplayName` attribute.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface pl.poznan.put.torsion.AtomBasedTorsionAngleType
calculate, calculate, findAtomPairs, longDisplayName

- Method Detail
  - moleculeType
```
public MoleculeType moleculeType()
```
    Specified by:
    
    moleculeType in interface AtomBasedTorsionAngleType
    
    Specified by:
    
    moleculeType in interface TorsionAngleType
    
    Returns:
    
    The value of the moleculeType attribute
  - shortDisplayName
```
public String shortDisplayName()
```
    Specified by:
    
    shortDisplayName in interface AtomBasedTorsionAngleType
    
    Specified by:
    
    shortDisplayName in interface DisplayableExportable
    
    Returns:
    
    The value of the shortDisplayName attribute
  - exportName
```
public String exportName()
```
    Specified by:
    
    exportName in interface AtomBasedTorsionAngleType
    
    Specified by:
    
    exportName in interface DisplayableExportable
    
    Returns:
    
    The value of the exportName attribute
  - atoms
```
public Quadruple<AtomName> atoms()
```
    Specified by:
    
    atoms in interface AtomBasedTorsionAngleType
    
    Returns:
    
    The quadruple of atoms defining this torsion angle type.
  - residueRule
```
public Quadruple<Integer> residueRule()
```
    Specified by:
    
    residueRule in interface AtomBasedTorsionAngleType
    
    Returns:
    
    The quadruple of relative indices to take atoms from. For example, a rule (0, 0, 0, 0) means that all atoms are from the same residue, while a rule (-1, 0, 0, 0) means that the first atom is taken from the preceding residue.
  - isPseudoTorsion
```
public boolean isPseudoTorsion()
```
    Specified by:
    
    isPseudoTorsion in interface AtomBasedTorsionAngleType
    
    Returns:
    
    True if this is an instance of a pseudo-torsion angle type. A pseudo-torsion angle type is defined on a quadruple of atoms which are not connected (See NucleotideTorsionAngle.ETA or AminoAcidTorsionAngle.CALPHA).
  - withMoleculeType
```
public final ImmutableAtomBasedTorsionAngleType 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
  - withShortDisplayName
```
public final ImmutableAtomBasedTorsionAngleType withShortDisplayName(String value)
```
    Copy the current immutable object by setting a value for the shortDisplayName attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for shortDisplayName
    
    Returns:
    
    A modified copy of the this object
  - withExportName
```
public final ImmutableAtomBasedTorsionAngleType withExportName(String value)
```
    Copy the current immutable object by setting a value for the exportName attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for exportName
    
    Returns:
    
    A modified copy of the this object
  - withAtoms
```
public final ImmutableAtomBasedTorsionAngleType withAtoms(Quadruple<AtomName> value)
```
    Copy the current immutable object by setting a value for the atoms attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for atoms
    
    Returns:
    
    A modified copy of the this object
  - withResidueRule
```
public final ImmutableAtomBasedTorsionAngleType withResidueRule(Quadruple<Integer> value)
```
    Copy the current immutable object by setting a value for the residueRule attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for residueRule
    
    Returns:
    
    A modified copy of the this object
  - withIsPseudoTorsion
```
public final ImmutableAtomBasedTorsionAngleType withIsPseudoTorsion(boolean value)
```
    Copy the current immutable object by setting a value for the isPseudoTorsion attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for isPseudoTorsion
    
    Returns:
    
    A modified copy of the this object
  - equals
```
public boolean equals(@Nullable
                      Object another)
```
    This instance is equal to all instances of ImmutableAtomBasedTorsionAngleType 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, shortDisplayName, exportName, atoms, residueRule, isPseudoTorsion.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hashCode value
  - toString
```
public String toString()
```
    Prints the immutable value AtomBasedTorsionAngleType with attribute values.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of the value
  - of
```
public static ImmutableAtomBasedTorsionAngleType of(MoleculeType moleculeType,
                                                    String shortDisplayName,
                                                    String exportName,
                                                    Quadruple<AtomName> atoms,
                                                    Quadruple<Integer> residueRule)
```
    Construct a new immutable AtomBasedTorsionAngleType instance.
    
    Parameters:
    
    moleculeType - The value for the moleculeType attribute
    
    shortDisplayName - The value for the shortDisplayName attribute
    
    exportName - The value for the exportName attribute
    
    atoms - The value for the atoms attribute
    
    residueRule - The value for the residueRule attribute
    
    Returns:
    
    An immutable AtomBasedTorsionAngleType instance
  - copyOf
```
public static ImmutableAtomBasedTorsionAngleType copyOf(AtomBasedTorsionAngleType instance)
```
    Creates an immutable copy of a AtomBasedTorsionAngleType 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 AtomBasedTorsionAngleType instance
  - builder
```
public static ImmutableAtomBasedTorsionAngleType.Builder builder()
```
    Creates a builder for ImmutableAtomBasedTorsionAngleType.
    ImmutableAtomBasedTorsionAngleType.builder() .moleculeType(pl.poznan.put.pdb.analysis.MoleculeType) // required moleculeType .shortDisplayName(String) // required shortDisplayName .exportName(String) // required exportName .atoms(pl.poznan.put.types.Quadruple<pl.poznan.put.atom.AtomName>) // required atoms .residueRule(pl.poznan.put.types.Quadruple<Integer>) // required residueRule .isPseudoTorsion(boolean) // optional isPseudoTorsion .build();
    Returns:
    
    A new ImmutableAtomBasedTorsionAngleType builder

Class ImmutableAtomBasedTorsionAngleType

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface pl.poznan.put.torsion.AtomBasedTorsionAngleType

Method Detail

moleculeType

shortDisplayName

exportName

atoms

residueRule

isPseudoTorsion

withMoleculeType

withShortDisplayName

withExportName

withAtoms

withResidueRule

withIsPseudoTorsion

equals

hashCode

toString

of

copyOf

builder