ImmutableBasePair.Builder (BioCommons 3.0.4 API)

java.lang.Object
- pl.poznan.put.structure.ImmutableBasePair.Builder

Enclosing class:

ImmutableBasePair
```
@NotThreadSafe
public static final class ImmutableBasePair.Builder
extends Object
```
Builds instances of type ImmutableBasePair. Initialize attributes and then invoke the build() method to create an immutable instance.
Builder is not thread-safe and generally should not be stored in a field or collection, but instead used immediately to create instances.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`ImmutableBasePair`	`build()`	Builds a new `ImmutableBasePair`.
`ImmutableBasePair.Builder`	`from(BasePair instance)`	Fill a builder with attribute values from the provided `BasePair` instance.
`ImmutableBasePair.Builder`	`left(PdbNamedResidueIdentifier left)`	Initializes the value for the `left` attribute.
`ImmutableBasePair.Builder`	`right(PdbNamedResidueIdentifier right)`	Initializes the value for the `right` attribute.

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

- Method Detail
  - from
```
public final ImmutableBasePair.Builder from(BasePair instance)
```
    Fill a builder with attribute values from the provided BasePair instance. Regular attribute values will be replaced with those from the given instance. Absent optional values will not replace present values.
    
    Parameters:
    
    instance - The instance from which to copy values
    
    Returns:
    
    this builder for use in a chained invocation
  - left
```
public final ImmutableBasePair.Builder left(PdbNamedResidueIdentifier left)
```
    Initializes the value for the left attribute.
    
    Parameters:
    
    left - The value for left
    
    Returns:
    
    this builder for use in a chained invocation
  - right
```
public final ImmutableBasePair.Builder right(PdbNamedResidueIdentifier right)
```
    Initializes the value for the right attribute.
    
    Parameters:
    
    right - The value for right
    
    Returns:
    
    this builder for use in a chained invocation
  - build
```
public ImmutableBasePair build()
```
    Builds a new ImmutableBasePair.
    
    Returns:
    
    An immutable instance of BasePair
    
    Throws:
    
    IllegalStateException - if any required attributes are missing