Package pl.poznan.put.pdb.analysis

Class ImmutableDefaultResidueCollection.Builder

java.lang.Object

pl.poznan.put.pdb.analysis.ImmutableDefaultResidueCollection.Builder

Enclosing class:

ImmutableDefaultResidueCollection

@NotThreadSafe
public static final class ImmutableDefaultResidueCollection.Builder
extends Object

Builds instances of type ImmutableDefaultResidueCollection. 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
final ImmutableDefaultResidueCollection.Builder	addAllResidues(Iterable<? extends PdbResidue> elements)	Adds elements to residues list.
final ImmutableDefaultResidueCollection.Builder	addResidues(PdbResidue element)	Adds one element to residues list.
final ImmutableDefaultResidueCollection.Builder	addResidues(PdbResidue... elements)	Adds elements to residues list.
ImmutableDefaultResidueCollection	build()	Builds a new ImmutableDefaultResidueCollection.
final ImmutableDefaultResidueCollection.Builder	from(DefaultResidueCollection instance)	Fill a builder with attribute values from the provided pl.poznan.put.pdb.analysis.DefaultResidueCollection instance.
final ImmutableDefaultResidueCollection.Builder	from(ResidueCollection instance)	Fill a builder with attribute values from the provided pl.poznan.put.pdb.analysis.ResidueCollection instance.
final ImmutableDefaultResidueCollection.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 Details

from

public final ImmutableDefaultResidueCollection.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

from

public final ImmutableDefaultResidueCollection.Builder from(DefaultResidueCollection instance)

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

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

addResidues

public final ImmutableDefaultResidueCollection.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 ImmutableDefaultResidueCollection.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 ImmutableDefaultResidueCollection.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 ImmutableDefaultResidueCollection.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 ImmutableDefaultResidueCollection build()

Builds a new ImmutableDefaultResidueCollection.

Returns:

An immutable instance of DefaultResidueCollection

Throws:

IllegalStateException - if any required attributes are missing