java.lang.Object
- pl.poznan.put.rna.BasePairParameters
- - pl.poznan.put.rna.ImmutableBasePairParameters

```
@ParametersAreNonnullByDefault
@Generated("org.immutables.processor.ProxyProcessor")
@Immutable
public final class ImmutableBasePairParameters
extends BasePairParameters
```
Immutable implementation of BasePairParameters.
Use the builder to create immutable instances: ImmutableBasePairParameters.builder(). Use the static factory method to create immutable instances: ImmutableBasePairParameters.of().

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class ImmutableBasePairParameters.Builder
Builds instances of type ImmutableBasePairParameters.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Angle`	`buckle()`
`static ImmutableBasePairParameters.Builder`	`builder()`	Creates a builder for `ImmutableBasePairParameters`.
`static ImmutableBasePairParameters`	`copyOf(BasePairParameters instance)`	Creates an immutable copy of a `BasePairParameters` value.
`boolean`	`equals(Object another)`	This instance is equal to all instances of `ImmutableBasePairParameters` that have equal attribute values.
`int`	`hashCode()`	Computes a hash code from attributes: `shear`, `stretch`, `stagger`, `buckle`, `propeller`, `opening`, `interBaseAngle`.
`Angle`	`interBaseAngle()`
`static ImmutableBasePairParameters`	`of(double shear, double stretch, double stagger, Angle buckle, Angle propeller, Angle opening, Angle interBaseAngle)`	Construct a new immutable `BasePairParameters` instance.
`Angle`	`opening()`
`Angle`	`propeller()`
`double`	`shear()`
`double`	`stagger()`
`double`	`stretch()`
`String`	`toString()`	Prints the immutable value `BasePairParameters` with attribute values.
`ImmutableBasePairParameters`	`withBuckle(Angle value)`	Copy the current immutable object by setting a value for the `buckle` attribute.
`ImmutableBasePairParameters`	`withInterBaseAngle(Angle value)`	Copy the current immutable object by setting a value for the `interBaseAngle` attribute.
`ImmutableBasePairParameters`	`withOpening(Angle value)`	Copy the current immutable object by setting a value for the `opening` attribute.
`ImmutableBasePairParameters`	`withPropeller(Angle value)`	Copy the current immutable object by setting a value for the `propeller` attribute.
`ImmutableBasePairParameters`	`withShear(double value)`	Copy the current immutable object by setting a value for the `shear` attribute.
`ImmutableBasePairParameters`	`withStagger(double value)`	Copy the current immutable object by setting a value for the `stagger` attribute.
`ImmutableBasePairParameters`	`withStretch(double value)`	Copy the current immutable object by setting a value for the `stretch` attribute.

Methods inherited from class pl.poznan.put.rna.BasePairParameters
of

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

- Method Detail
  - shear
```
public double shear()
```
    Specified by:
    
    shear in class BasePairParameters
    
    Returns:
    
    The value of the shear attribute
  - stretch
```
public double stretch()
```
    Specified by:
    
    stretch in class BasePairParameters
    
    Returns:
    
    The value of the stretch attribute
  - stagger
```
public double stagger()
```
    Specified by:
    
    stagger in class BasePairParameters
    
    Returns:
    
    The value of the stagger attribute
  - buckle
```
public Angle buckle()
```
    Specified by:
    
    buckle in class BasePairParameters
    
    Returns:
    
    The value of the buckle attribute
  - propeller
```
public Angle propeller()
```
    Specified by:
    
    propeller in class BasePairParameters
    
    Returns:
    
    The value of the propeller attribute
  - opening
```
public Angle opening()
```
    Specified by:
    
    opening in class BasePairParameters
    
    Returns:
    
    The value of the opening attribute
  - interBaseAngle
```
public Angle interBaseAngle()
```
    Specified by:
    
    interBaseAngle in class BasePairParameters
    
    Returns:
    
    The value of the interBaseAngle attribute
  - withShear
```
public final ImmutableBasePairParameters withShear(double value)
```
    Copy the current immutable object by setting a value for the shear attribute. A value strict bits equality used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for shear
    
    Returns:
    
    A modified copy of the this object
  - withStretch
```
public final ImmutableBasePairParameters withStretch(double value)
```
    Copy the current immutable object by setting a value for the stretch attribute. A value strict bits equality used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for stretch
    
    Returns:
    
    A modified copy of the this object
  - withStagger
```
public final ImmutableBasePairParameters withStagger(double value)
```
    Copy the current immutable object by setting a value for the stagger attribute. A value strict bits equality used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for stagger
    
    Returns:
    
    A modified copy of the this object
  - withBuckle
```
public final ImmutableBasePairParameters withBuckle(Angle value)
```
    Copy the current immutable object by setting a value for the buckle attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for buckle
    
    Returns:
    
    A modified copy of the this object
  - withPropeller
```
public final ImmutableBasePairParameters withPropeller(Angle value)
```
    Copy the current immutable object by setting a value for the propeller attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for propeller
    
    Returns:
    
    A modified copy of the this object
  - withOpening
```
public final ImmutableBasePairParameters withOpening(Angle value)
```
    Copy the current immutable object by setting a value for the opening attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for opening
    
    Returns:
    
    A modified copy of the this object
  - withInterBaseAngle
```
public final ImmutableBasePairParameters withInterBaseAngle(Angle value)
```
    Copy the current immutable object by setting a value for the interBaseAngle attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for interBaseAngle
    
    Returns:
    
    A modified copy of the this object
  - equals
```
public boolean equals(@Nullable
                      Object another)
```
    This instance is equal to all instances of ImmutableBasePairParameters 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: shear, stretch, stagger, buckle, propeller, opening, interBaseAngle.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hashCode value
  - toString
```
public String toString()
```
    Prints the immutable value BasePairParameters with attribute values.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of the value
  - of
```
public static ImmutableBasePairParameters of(double shear,
                                             double stretch,
                                             double stagger,
                                             Angle buckle,
                                             Angle propeller,
                                             Angle opening,
                                             Angle interBaseAngle)
```
    Construct a new immutable BasePairParameters instance.
    
    Parameters:
    
    shear - The value for the shear attribute
    
    stretch - The value for the stretch attribute
    
    stagger - The value for the stagger attribute
    
    buckle - The value for the buckle attribute
    
    propeller - The value for the propeller attribute
    
    opening - The value for the opening attribute
    
    interBaseAngle - The value for the interBaseAngle attribute
    
    Returns:
    
    An immutable BasePairParameters instance
  - copyOf
```
public static ImmutableBasePairParameters copyOf(BasePairParameters instance)
```
    Creates an immutable copy of a BasePairParameters 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 BasePairParameters instance
  - builder
```
public static ImmutableBasePairParameters.Builder builder()
```
    Creates a builder for ImmutableBasePairParameters.
    ImmutableBasePairParameters.builder() .shear(double) // required shear .stretch(double) // required stretch .stagger(double) // required stagger .buckle(pl.poznan.put.circular.Angle) // required buckle .propeller(pl.poznan.put.circular.Angle) // required propeller .opening(pl.poznan.put.circular.Angle) // required opening .interBaseAngle(pl.poznan.put.circular.Angle) // required interBaseAngle .build();
    Returns:
    
    A new ImmutableBasePairParameters builder

Class ImmutableBasePairParameters

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

Method Detail

shear

stretch

stagger

buckle

propeller

opening

interBaseAngle

withShear

withStretch

withStagger

withBuckle

withPropeller

withOpening

withInterBaseAngle

equals

hashCode

toString

of

copyOf

builder