Package net.bmahe.genetics4j.core.spec.mutation

Class ImmutablePartialMutation.Builder

java.lang.Object

net.bmahe.genetics4j.core.spec.mutation.ImmutablePartialMutation.Builder

Enclosing class:

ImmutablePartialMutation

public static final class ImmutablePartialMutation.Builder
extends Object

Builds instances of type ImmutablePartialMutation. 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.

Field Summary

Fields

Modifier and Type	Field	Description
private int	chromosomeIndex
private static final long	INIT_BIT_CHROMOSOME_INDEX
private static final long	INIT_BIT_MUTATION_POLICY
private long	initBits
private MutationPolicy	mutationPolicy

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Builder()

Method Summary

Modifier and Type	Method	Description
ImmutablePartialMutation	build()	Builds a new ImmutablePartialMutation.
final ImmutablePartialMutation.Builder	chromosomeIndex(int chromosomeIndex)	Initializes the value for the chromosomeIndex attribute.
private String	formatRequiredAttributesMessage()
final ImmutablePartialMutation.Builder	from(PartialMutation instance)	Fill a builder with attribute values from the provided PartialMutation instance.
final ImmutablePartialMutation.Builder	mutationPolicy(MutationPolicy mutationPolicy)	Initializes the value for the mutationPolicy attribute.

Methods inherited from class java.lang.Object

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

Field Details

INIT_BIT_CHROMOSOME_INDEX

private static final long INIT_BIT_CHROMOSOME_INDEX

See Also:

• Constant Field Values

INIT_BIT_MUTATION_POLICY

private static final long INIT_BIT_MUTATION_POLICY

See Also:

• Constant Field Values

initBits

private long initBits

chromosomeIndex

private int chromosomeIndex

mutationPolicy

private MutationPolicy mutationPolicy

Constructor Details

Builder

private Builder()

Method Details

from

public final ImmutablePartialMutation.Builder from(PartialMutation instance)

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

chromosomeIndex

public final ImmutablePartialMutation.Builder chromosomeIndex(int chromosomeIndex)

Initializes the value for the chromosomeIndex attribute.

Parameters:

chromosomeIndex - The value for chromosomeIndex

Returns:

this builder for use in a chained invocation

mutationPolicy

public final ImmutablePartialMutation.Builder mutationPolicy(MutationPolicy mutationPolicy)

Initializes the value for the mutationPolicy attribute.

Parameters:

mutationPolicy - The value for mutationPolicy

Returns:

this builder for use in a chained invocation

build

public ImmutablePartialMutation build()

Builds a new ImmutablePartialMutation.

Returns:

An immutable instance of PartialMutation

Throws:

IllegalStateException - if any required attributes are missing

formatRequiredAttributesMessage

private String formatRequiredAttributesMessage()