Package com.dna.jopt.member.unit.zonemanager

Class ZoneConnection.Builder

java.lang.Object

com.dna.jopt.member.unit.zonemanager.ZoneConnection.Builder

All Implemented Interfaces:

ZoneConnection.BuildFinal, ZoneConnection.FromZoneIdBuildStage, ZoneConnection.ToZoneIdBuildStage

Enclosing class:

ZoneConnection

@NotThreadSafe
public static final class ZoneConnection.Builder
extends Object
implements ZoneConnection.FromZoneIdBuildStage, ZoneConnection.ToZoneIdBuildStage, ZoneConnection.BuildFinal

Builds instances of type ZoneConnection. 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
ZoneConnection	build()	Builds a new ZoneConnection.
final ZoneConnection.Builder	crossingPenaltyMultiplier(double crossingPenaltyMultiplier)	Initializes the value for the crossingPenaltyMultiplier attribute.
final ZoneConnection.Builder	fromZoneId(String fromZoneId)	Initializes the value for the fromZoneId attribute.
final ZoneConnection.Builder	toZoneId(String toZoneId)	Initializes the value for the toZoneId attribute.

Methods inherited from class java.lang.Object

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

Method Details

fromZoneId

@CanIgnoreReturnValue
public final ZoneConnection.Builder fromZoneId(String fromZoneId)

Initializes the value for the fromZoneId attribute.

Specified by:

fromZoneId in interface ZoneConnection.FromZoneIdBuildStage

Parameters:

fromZoneId - The value for fromZoneId

Returns:

this builder for use in a chained invocation

toZoneId

@CanIgnoreReturnValue
public final ZoneConnection.Builder toZoneId(String toZoneId)

Initializes the value for the toZoneId attribute.

Specified by:

toZoneId in interface ZoneConnection.ToZoneIdBuildStage

Parameters:

toZoneId - The value for toZoneId

Returns:

this builder for use in a chained invocation

crossingPenaltyMultiplier

@CanIgnoreReturnValue
public final ZoneConnection.Builder crossingPenaltyMultiplier(double crossingPenaltyMultiplier)

Initializes the value for the crossingPenaltyMultiplier attribute.

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

Specified by:

crossingPenaltyMultiplier in interface ZoneConnection.BuildFinal

Parameters:

crossingPenaltyMultiplier - The value for crossingPenaltyMultiplier

Returns:

this builder for use in a chained invocation

build

public ZoneConnection build()

Builds a new ZoneConnection.

Specified by:

build in interface ZoneConnection.BuildFinal

Returns:

An immutable instance of ZoneConnection

Throws:

IllegalStateException - if any required attributes are missing