Package pl.poznan.put.pdb

Class ImmutablePdbResidueIdentifier.Builder

java.lang.Object

pl.poznan.put.pdb.ImmutablePdbResidueIdentifier.Builder

Enclosing class:

ImmutablePdbResidueIdentifier

@NotThreadSafe
public static final class ImmutablePdbResidueIdentifier.Builder
extends Object

Builds instances of type ImmutablePdbResidueIdentifier. 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

Modifier and Type	Method	Description
ImmutablePdbResidueIdentifier	build()	Builds a new ImmutablePdbResidueIdentifier.
final ImmutablePdbResidueIdentifier.Builder	chainIdentifier(String chainIdentifier)	Initializes the value for the chainIdentifier attribute.
final ImmutablePdbResidueIdentifier.Builder	from(ChainNumberICode instance)	Fill a builder with attribute values from the provided pl.poznan.put.pdb.ChainNumberICode instance.
final ImmutablePdbResidueIdentifier.Builder	from(PdbResidueIdentifier instance)	Fill a builder with attribute values from the provided pl.poznan.put.pdb.PdbResidueIdentifier instance.
final ImmutablePdbResidueIdentifier.Builder	insertionCode(String insertionCode)	Initializes the optional value insertionCode to insertionCode.
final ImmutablePdbResidueIdentifier.Builder	insertionCode(Optional<String> insertionCode)	Initializes the optional value insertionCode to insertionCode.
final ImmutablePdbResidueIdentifier.Builder	residueNumber(int residueNumber)	Initializes the value for the residueNumber attribute.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

from

public final ImmutablePdbResidueIdentifier.Builder from(PdbResidueIdentifier instance)

Fill a builder with attribute values from the provided pl.poznan.put.pdb.PdbResidueIdentifier instance.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

from

public final ImmutablePdbResidueIdentifier.Builder from(ChainNumberICode instance)

Fill a builder with attribute values from the provided pl.poznan.put.pdb.ChainNumberICode instance.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

chainIdentifier

public final ImmutablePdbResidueIdentifier.Builder chainIdentifier(String chainIdentifier)

Initializes the value for the chainIdentifier attribute.

Parameters:

chainIdentifier - The value for chainIdentifier

Returns:

this builder for use in a chained invocation

residueNumber

public final ImmutablePdbResidueIdentifier.Builder residueNumber(int residueNumber)

Initializes the value for the residueNumber attribute.

Parameters:

residueNumber - The value for residueNumber

Returns:

this builder for use in a chained invocation

insertionCode

public final ImmutablePdbResidueIdentifier.Builder insertionCode(String insertionCode)

Initializes the optional value insertionCode to insertionCode.

Parameters:

insertionCode - The value for insertionCode

Returns:

this builder for chained invocation

insertionCode

public final ImmutablePdbResidueIdentifier.Builder insertionCode(Optional<String> insertionCode)

Initializes the optional value insertionCode to insertionCode.

Parameters:

insertionCode - The value for insertionCode

Returns:

this builder for use in a chained invocation

build

public ImmutablePdbResidueIdentifier build()

Builds a new ImmutablePdbResidueIdentifier.

Returns:

An immutable instance of PdbResidueIdentifier

Throws:

IllegalStateException - if any required attributes are missing