Package pl.poznan.put.external.dssr

Class ImmutableNucleotide.Builder

java.lang.Object

pl.poznan.put.external.dssr.ImmutableNucleotide.Builder

Enclosing class:

ImmutableNucleotide

@NotThreadSafe
public static final class ImmutableNucleotide.Builder
extends Object

Builds instances of type ImmutableNucleotide. 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
ImmutableNucleotide	build()	Builds a new ImmutableNucleotide.
ImmutableNucleotide.Builder	chainName(String chainName)	Initializes the value for the chainName attribute.
ImmutableNucleotide.Builder	from(Nucleotide instance)	Fill a builder with attribute values from the provided Nucleotide instance.
ImmutableNucleotide.Builder	id(String id)	Initializes the value for the id attribute.
ImmutableNucleotide.Builder	oneLetterName(String oneLetterName)	Initializes the value for the oneLetterName attribute.
ImmutableNucleotide.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 Detail

from

public final ImmutableNucleotide.Builder from(Nucleotide instance)

Fill a builder with attribute values from the provided Nucleotide 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

id

public final ImmutableNucleotide.Builder id(String id)

Initializes the value for the id attribute.

Parameters:

id - The value for id

Returns:

this builder for use in a chained invocation

chainName

public final ImmutableNucleotide.Builder chainName(String chainName)

Initializes the value for the chainName attribute.

Parameters:

chainName - The value for chainName

Returns:

this builder for use in a chained invocation

oneLetterName

public final ImmutableNucleotide.Builder oneLetterName(String oneLetterName)

Initializes the value for the oneLetterName attribute.

Parameters:

oneLetterName - The value for oneLetterName

Returns:

this builder for use in a chained invocation

residueNumber

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

build

public ImmutableNucleotide build()

Builds a new ImmutableNucleotide.

Returns:

An immutable instance of Nucleotide

Throws:

IllegalStateException - if any required attributes are missing