Package net.bmahe.genetics4j.core.chromosomes.factory

Class ImmutableChromosomeFactoryProvider

java.lang.Object

net.bmahe.genetics4j.core.chromosomes.factory.ChromosomeFactoryProvider

net.bmahe.genetics4j.core.chromosomes.factory.ImmutableChromosomeFactoryProvider

@Generated(from="ChromosomeFactoryProvider",
           generator="Immutables")
@Generated("org.immutables.processor.ProxyProcessor")
public final class ImmutableChromosomeFactoryProvider
extends ChromosomeFactoryProvider

Immutable implementation of ChromosomeFactoryProvider.

Use the builder to create immutable instances: ImmutableChromosomeFactoryProvider.builder().

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ImmutableChromosomeFactoryProvider.Builder	Builds instances of type ChromosomeFactoryProvider.
private final class	ImmutableChromosomeFactoryProvider.InitShim

Field Summary

Fields

Modifier and Type	Field	Description
private final List<ChromosomeFactory<? extends Chromosome>>	chromosomeFactories
private final List<Function<ChromosomeFactoryProvider,ChromosomeFactory<? extends Chromosome>>>	chromosomeFactoriesGenerator
private final List<ChromosomeFactory<? extends Chromosome>>	defaultChromosomeFactories
private ImmutableChromosomeFactoryProvider.InitShim	initShim
private final RandomGenerator	randomGenerator
private static final byte	STAGE_INITIALIZED
private static final byte	STAGE_INITIALIZING
private static final byte	STAGE_UNINITIALIZED

Fields inherited from class net.bmahe.genetics4j.core.chromosomes.factory.ChromosomeFactoryProvider

logger

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ImmutableChromosomeFactoryProvider(RandomGenerator randomGenerator, List<ChromosomeFactory<? extends Chromosome>> defaultChromosomeFactories, List<Function<ChromosomeFactoryProvider,ChromosomeFactory<? extends Chromosome>>> chromosomeFactoriesGenerator)
private	ImmutableChromosomeFactoryProvider(ImmutableChromosomeFactoryProvider.Builder builder)

Method Summary

Modifier and Type	Method	Description
static ImmutableChromosomeFactoryProvider.Builder	builder()	Creates a builder for ChromosomeFactoryProvider.
List<ChromosomeFactory<? extends Chromosome>>	chromosomeFactories()
List<Function<ChromosomeFactoryProvider,ChromosomeFactory<? extends Chromosome>>>	chromosomeFactoriesGenerator()
static ChromosomeFactoryProvider	copyOf(ChromosomeFactoryProvider instance)	Creates an immutable copy of a ChromosomeFactoryProvider value.
private static <T> List<T>	createSafeList(Iterable<? extends T> iterable, boolean checkNulls, boolean skipNulls)
private static <T> List<T>	createUnmodifiableList(boolean clone, List<? extends T> list)
List<ChromosomeFactory<? extends Chromosome>>	defaultChromosomeFactories()
boolean	equals(Object another)	This instance is equal to all instances of ImmutableChromosomeFactoryProvider that have equal attribute values.
private boolean	equalsByValue(ImmutableChromosomeFactoryProvider another)
int	hashCode()	Computes a hash code from attributes: randomGenerator, defaultChromosomeFactories, chromosomeFactoriesGenerator, chromosomeFactories.
RandomGenerator	randomGenerator()
String	toString()	Prints the immutable value ChromosomeFactoryProvider with attribute values.
final ImmutableChromosomeFactoryProvider	withChromosomeFactoriesGenerator(Iterable<? extends Function<ChromosomeFactoryProvider,ChromosomeFactory<? extends Chromosome>>> elements)	Copy the current immutable object with elements that replace the content of chromosomeFactoriesGenerator.
final ImmutableChromosomeFactoryProvider	withChromosomeFactoriesGenerator(Function<ChromosomeFactoryProvider,ChromosomeFactory<? extends Chromosome>>... elements)	Copy the current immutable object with elements that replace the content of chromosomeFactoriesGenerator.
final ImmutableChromosomeFactoryProvider	withDefaultChromosomeFactories(Iterable<? extends ChromosomeFactory<? extends Chromosome>> elements)	Copy the current immutable object with elements that replace the content of defaultChromosomeFactories.
final ImmutableChromosomeFactoryProvider	withDefaultChromosomeFactories(ChromosomeFactory<? extends Chromosome>... elements)	Copy the current immutable object with elements that replace the content of defaultChromosomeFactories.
final ImmutableChromosomeFactoryProvider	withRandomGenerator(RandomGenerator value)	Copy the current immutable object by setting a value for the randomGenerator attribute.

Methods inherited from class net.bmahe.genetics4j.core.chromosomes.factory.ChromosomeFactoryProvider

provideChromosomeFactory

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

randomGenerator

private final RandomGenerator randomGenerator

defaultChromosomeFactories

private final List<ChromosomeFactory<? extends Chromosome>> defaultChromosomeFactories

chromosomeFactoriesGenerator

private final List<Function<ChromosomeFactoryProvider,ChromosomeFactory<? extends Chromosome>>> chromosomeFactoriesGenerator

chromosomeFactories

private final transient List<ChromosomeFactory<? extends Chromosome>> chromosomeFactories

STAGE_INITIALIZING

private static final byte STAGE_INITIALIZING

See Also:

• Constant Field Values

STAGE_UNINITIALIZED

private static final byte STAGE_UNINITIALIZED

See Also:

• Constant Field Values

STAGE_INITIALIZED

private static final byte STAGE_INITIALIZED

See Also:

• Constant Field Values

initShim

private transient volatile ImmutableChromosomeFactoryProvider.InitShim initShim

Constructor Details

ImmutableChromosomeFactoryProvider

private ImmutableChromosomeFactoryProvider(ImmutableChromosomeFactoryProvider.Builder builder)

ImmutableChromosomeFactoryProvider

private ImmutableChromosomeFactoryProvider(RandomGenerator randomGenerator,
 List<ChromosomeFactory<? extends Chromosome>> defaultChromosomeFactories,
 List<Function<ChromosomeFactoryProvider,ChromosomeFactory<? extends Chromosome>>> chromosomeFactoriesGenerator)

Method Details

randomGenerator

public RandomGenerator randomGenerator()

Specified by:

randomGenerator in class ChromosomeFactoryProvider

Returns:

The value of the randomGenerator attribute

defaultChromosomeFactories

public List<ChromosomeFactory<? extends Chromosome>> defaultChromosomeFactories()

Overrides:

defaultChromosomeFactories in class ChromosomeFactoryProvider

Returns:

The value of the defaultChromosomeFactories attribute

chromosomeFactoriesGenerator

public List<Function<ChromosomeFactoryProvider,ChromosomeFactory<? extends Chromosome>>> chromosomeFactoriesGenerator()

Specified by:

chromosomeFactoriesGenerator in class ChromosomeFactoryProvider

Returns:

The value of the chromosomeFactoriesGenerator attribute

chromosomeFactories

public List<ChromosomeFactory<? extends Chromosome>> chromosomeFactories()

Overrides:

chromosomeFactories in class ChromosomeFactoryProvider

Returns:

The computed-at-construction value of the chromosomeFactories attribute

withRandomGenerator

public final ImmutableChromosomeFactoryProvider withRandomGenerator(RandomGenerator value)

Copy the current immutable object by setting a value for the randomGenerator attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for randomGenerator

Returns:

A modified copy or the this object

withDefaultChromosomeFactories

@SafeVarargs
public final ImmutableChromosomeFactoryProvider withDefaultChromosomeFactories(ChromosomeFactory<? extends Chromosome>... elements)

Copy the current immutable object with elements that replace the content of defaultChromosomeFactories.

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withDefaultChromosomeFactories

public final ImmutableChromosomeFactoryProvider withDefaultChromosomeFactories(Iterable<? extends ChromosomeFactory<? extends Chromosome>> elements)

Copy the current immutable object with elements that replace the content of defaultChromosomeFactories. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

elements - An iterable of defaultChromosomeFactories elements to set

Returns:

A modified copy or this if not changed

withChromosomeFactoriesGenerator

@SafeVarargs
public final ImmutableChromosomeFactoryProvider withChromosomeFactoriesGenerator(Function<ChromosomeFactoryProvider,ChromosomeFactory<? extends Chromosome>>... elements)

Copy the current immutable object with elements that replace the content of chromosomeFactoriesGenerator.

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withChromosomeFactoriesGenerator

public final ImmutableChromosomeFactoryProvider withChromosomeFactoriesGenerator(Iterable<? extends Function<ChromosomeFactoryProvider,ChromosomeFactory<? extends Chromosome>>> elements)

Copy the current immutable object with elements that replace the content of chromosomeFactoriesGenerator. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

elements - An iterable of chromosomeFactoriesGenerator elements to set

Returns:

A modified copy or this if not changed

equals

public boolean equals(Object another)

This instance is equal to all instances of ImmutableChromosomeFactoryProvider that have equal attribute values.

Overrides:

equals in class Object

Returns:

true if this is equal to another instance

equalsByValue

private boolean equalsByValue(ImmutableChromosomeFactoryProvider another)

hashCode

public int hashCode()

Computes a hash code from attributes: randomGenerator, defaultChromosomeFactories, chromosomeFactoriesGenerator, chromosomeFactories.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value ChromosomeFactoryProvider with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ChromosomeFactoryProvider copyOf(ChromosomeFactoryProvider instance)

Creates an immutable copy of a ChromosomeFactoryProvider value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.

Parameters:

instance - The instance to copy

Returns:

A copied immutable ChromosomeFactoryProvider instance

builder

public static ImmutableChromosomeFactoryProvider.Builder builder()

Creates a builder for ChromosomeFactoryProvider.

 ImmutableChromosomeFactoryProvider.builder()
    .randomGenerator(random.RandomGenerator) // required randomGenerator
    .addDefaultChromosomeFactories|addAllDefaultChromosomeFactories(net.bmahe.genetics4j.core.chromosomes.factory.ChromosomeFactory<? extends net.bmahe.genetics4j.core.chromosomes.Chromosome>) // defaultChromosomeFactories elements
    .addChromosomeFactoriesGenerator|addAllChromosomeFactoriesGenerator(function.Function<net.bmahe.genetics4j.core.chromosomes.factory.ChromosomeFactoryProvider, net.bmahe.genetics4j.core.chromosomes.factory.ChromosomeFactory<? extends net.bmahe.genetics4j.core.chromosomes.Chromosome>>) // chromosomeFactoriesGenerator elements
    .build();
 

Returns:

A new ChromosomeFactoryProvider builder

createSafeList

private static <T> List<T> createSafeList(Iterable<? extends T> iterable,
 boolean checkNulls,
 boolean skipNulls)

createUnmodifiableList

private static <T> List<T> createUnmodifiableList(boolean clone,
 List<? extends T> list)