Package pl.poznan.put.pdb.analysis

Class ImmutableDefaultPdbResidue.Builder

java.lang.Object

pl.poznan.put.pdb.analysis.ImmutableDefaultPdbResidue.Builder

Enclosing class:

ImmutableDefaultPdbResidue

@NotThreadSafe
public static final class ImmutableDefaultPdbResidue.Builder
extends Object

Builds instances of type ImmutableDefaultPdbResidue. 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 ImmutableDefaultPdbResidue.Builder	addAllAtoms(Iterable<? extends PdbAtomLine> elements)	Adds elements to atoms list.
final ImmutableDefaultPdbResidue.Builder	addAtoms(PdbAtomLine element)	Adds one element to atoms list.
final ImmutableDefaultPdbResidue.Builder	addAtoms(PdbAtomLine... elements)	Adds elements to atoms list.
final ImmutableDefaultPdbResidue.Builder	atoms(Iterable<? extends PdbAtomLine> elements)	Sets or replaces all elements for atoms list.
ImmutableDefaultPdbResidue	build()	Builds a new ImmutableDefaultPdbResidue.
final ImmutableDefaultPdbResidue.Builder	from(DefaultPdbResidue instance)	Fill a builder with attribute values from the provided pl.poznan.put.pdb.analysis.DefaultPdbResidue instance.
final ImmutableDefaultPdbResidue.Builder	from(PdbResidue instance)	Fill a builder with attribute values from the provided pl.poznan.put.pdb.analysis.PdbResidue instance.
final ImmutableDefaultPdbResidue.Builder	identifier(PdbResidueIdentifier identifier)	Initializes the value for the identifier attribute.
final ImmutableDefaultPdbResidue.Builder	modifiedResidueName(String modifiedResidueName)	Initializes the value for the modifiedResidueName attribute.
final ImmutableDefaultPdbResidue.Builder	standardResidueName(String standardResidueName)	Initializes the value for the standardResidueName attribute.

Methods inherited from class java.lang.Object

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

Method Details

from

public final ImmutableDefaultPdbResidue.Builder from(PdbResidue instance)

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

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

from

public final ImmutableDefaultPdbResidue.Builder from(DefaultPdbResidue instance)

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

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

identifier

public final ImmutableDefaultPdbResidue.Builder identifier(PdbResidueIdentifier identifier)

Initializes the value for the identifier attribute.

Parameters:

identifier - The value for identifier

Returns:

this builder for use in a chained invocation

standardResidueName

public final ImmutableDefaultPdbResidue.Builder standardResidueName(String standardResidueName)

Initializes the value for the standardResidueName attribute.

Parameters:

standardResidueName - The value for standardResidueName

Returns:

this builder for use in a chained invocation

modifiedResidueName

public final ImmutableDefaultPdbResidue.Builder modifiedResidueName(String modifiedResidueName)

Initializes the value for the modifiedResidueName attribute.

Parameters:

modifiedResidueName - The value for modifiedResidueName

Returns:

this builder for use in a chained invocation

addAtoms

public final ImmutableDefaultPdbResidue.Builder addAtoms(PdbAtomLine element)

Adds one element to atoms list.

Parameters:

element - A atoms element

Returns:

this builder for use in a chained invocation

addAtoms

public final ImmutableDefaultPdbResidue.Builder addAtoms(PdbAtomLine... elements)

Adds elements to atoms list.

Parameters:

elements - An array of atoms elements

Returns:

this builder for use in a chained invocation

atoms

public final ImmutableDefaultPdbResidue.Builder atoms(Iterable<? extends PdbAtomLine> elements)

Sets or replaces all elements for atoms list.

Parameters:

elements - An iterable of atoms elements

Returns:

this builder for use in a chained invocation

addAllAtoms

public final ImmutableDefaultPdbResidue.Builder addAllAtoms(Iterable<? extends PdbAtomLine> elements)

Adds elements to atoms list.

Parameters:

elements - An iterable of atoms elements

Returns:

this builder for use in a chained invocation

build

public ImmutableDefaultPdbResidue build()

Builds a new ImmutableDefaultPdbResidue.

Returns:

An immutable instance of DefaultPdbResidue

Throws:

IllegalStateException - if any required attributes are missing