Package pl.poznan.put.pdb.analysis

Class ImmutablePdbChain.Builder

java.lang.Object

pl.poznan.put.pdb.analysis.ImmutablePdbChain.Builder

Enclosing class:

ImmutablePdbChain

@NotThreadSafe
public static final class ImmutablePdbChain.Builder
extends Object

Builds instances of type ImmutablePdbChain. 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
ImmutablePdbChain.Builder	addAllResidues(Iterable<? extends PdbResidue> elements)	Adds elements to residues list.
ImmutablePdbChain.Builder	addResidues(PdbResidue element)	Adds one element to residues list.
ImmutablePdbChain.Builder	addResidues(PdbResidue... elements)	Adds elements to residues list.
ImmutablePdbChain	build()	Builds a new ImmutablePdbChain.
ImmutablePdbChain.Builder	from(PdbChain instance)	Fill a builder with attribute values from the provided pl.poznan.put.pdb.analysis.PdbChain instance.
ImmutablePdbChain.Builder	from(ResidueCollection instance)	Fill a builder with attribute values from the provided pl.poznan.put.pdb.analysis.ResidueCollection instance.
ImmutablePdbChain.Builder	identifier(String identifier)	Initializes the value for the identifier attribute.
ImmutablePdbChain.Builder	residues(Iterable<? extends PdbResidue> elements)	Sets or replaces all elements for residues list.

Methods inherited from class java.lang.Object

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

Method Detail

from

public final ImmutablePdbChain.Builder from(PdbChain instance)

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

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

from

public final ImmutablePdbChain.Builder from(ResidueCollection instance)

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

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

identifier

public final ImmutablePdbChain.Builder identifier(String identifier)

Initializes the value for the identifier attribute.

Parameters:

identifier - The value for identifier

Returns:

this builder for use in a chained invocation

addResidues

public final ImmutablePdbChain.Builder addResidues(PdbResidue element)

Adds one element to residues list.

Parameters:

element - A residues element

Returns:

this builder for use in a chained invocation

addResidues

public final ImmutablePdbChain.Builder addResidues(PdbResidue... elements)

Adds elements to residues list.

Parameters:

elements - An array of residues elements

Returns:

this builder for use in a chained invocation

residues

public final ImmutablePdbChain.Builder residues(Iterable<? extends PdbResidue> elements)

Sets or replaces all elements for residues list.

Parameters:

elements - An iterable of residues elements

Returns:

this builder for use in a chained invocation

addAllResidues

public final ImmutablePdbChain.Builder addAllResidues(Iterable<? extends PdbResidue> elements)

Adds elements to residues list.

Parameters:

elements - An iterable of residues elements

Returns:

this builder for use in a chained invocation

build

public ImmutablePdbChain build()

Builds a new ImmutablePdbChain.

Returns:

An immutable instance of PdbChain

Throws:

IllegalStateException - if any required attributes are missing