Package pl.poznan.put.structure.formats

Class ImmutableEntry.Builder

java.lang.Object

pl.poznan.put.structure.formats.ImmutableEntry.Builder

Enclosing class:

ImmutableEntry

@NotThreadSafe
public static final class ImmutableEntry.Builder
extends Object

Builds instances of type ImmutableEntry. 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
ImmutableEntry	build()	Builds a new ImmutableEntry.
ImmutableEntry.Builder	comment(String comment)	Initializes the value for the comment attribute.
ImmutableEntry.Builder	from(BpSeq.Entry instance)	Fill a builder with attribute values from the provided Entry instance.
ImmutableEntry.Builder	index(int index)	Initializes the value for the index attribute.
ImmutableEntry.Builder	pair(int pair)	Initializes the value for the pair attribute.
ImmutableEntry.Builder	seq(char seq)	Initializes the value for the seq attribute.

Methods inherited from class java.lang.Object

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

Method Detail

from

public final ImmutableEntry.Builder from(BpSeq.Entry instance)

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

index

public final ImmutableEntry.Builder index(int index)

Initializes the value for the index attribute.

Parameters:

index - The value for index

Returns:

this builder for use in a chained invocation

seq

public final ImmutableEntry.Builder seq(char seq)

Initializes the value for the seq attribute.

Parameters:

seq - The value for seq

Returns:

this builder for use in a chained invocation

pair

public final ImmutableEntry.Builder pair(int pair)

Initializes the value for the pair attribute.

Parameters:

pair - The value for pair

Returns:

this builder for use in a chained invocation

comment

public final ImmutableEntry.Builder comment(String comment)

Initializes the value for the comment attribute.

If not set, this attribute will have a default value as returned by the initializer of comment.

Parameters:

comment - The value for comment

Returns:

this builder for use in a chained invocation

build

public ImmutableEntry build()

Builds a new ImmutableEntry.

Returns:

An immutable instance of Entry

Throws:

IllegalStateException - if any required attributes are missing