Package io.github.ai4ci.config

Class ModifiableExperimentConfiguration

java.lang.Object

io.github.ai4ci.config.ModifiableExperimentConfiguration

All Implemented Interfaces:

ExperimentConfiguration

@ParametersAreNonnullByDefault
@Generated({"Modifiables.generator","ExperimentConfiguration"})
@NotThreadSafe
public final class ModifiableExperimentConfiguration
extends Object
implements ExperimentConfiguration

A modifiable implementation of the ExperimentConfiguration type.

Use the create() static factory methods to create new instances. Use the toImmutable() method to convert to canonical immutable instances.

ModifiableExperimentConfiguration is not thread-safe

See Also:

• ImmutableExperimentConfiguration

Field Summary

Fields inherited from interface io.github.ai4ci.config.ExperimentConfiguration

DEFAULT

Method Summary

Modifier and Type	Method	Description
ModifiableExperimentConfiguration	addAllFacets(Iterable<? extends ImmutableExecutionFacet> elements)	Adds elements to facets list.
ModifiableExperimentConfiguration	addAllSetupConfig(Iterable<? extends ExperimentFacet.SetupFacet<?>> elements)	Adds elements to setupConfig list.
ModifiableExperimentConfiguration	addFacet(ImmutableExecutionFacet element)	Adds one element to facets list.
final ModifiableExperimentConfiguration	addFacets(ImmutableExecutionFacet... elements)	Adds elements to facets list.
ModifiableExperimentConfiguration	addSetupConfig(ExperimentFacet.SetupFacet<?> element)	Adds one element to setupConfig list.
final ModifiableExperimentConfiguration	addSetupConfig(ExperimentFacet.SetupFacet<?>... elements)	Adds elements to setupConfig list.
ModifiableExperimentConfiguration	clear()	Clears the object by setting all attributes to their initial values.
static ModifiableExperimentConfiguration	create()	Construct a modifiable instance of ExperimentConfiguration.
boolean	equals(Object another)	This instance is equal to all instances of ModifiableExperimentConfiguration that have equal attribute values.
ModifiableExperimentConfiguration	from(ExperimentConfiguration instance)	Fill this modifiable instance with attribute values from the provided ExperimentConfiguration instance.
ModifiableExperimentConfiguration	from(ModifiableExperimentConfiguration instance)	Fill this modifiable instance with attribute values from the provided ExperimentConfiguration instance.
final ImmutableBatchConfiguration	getBatchConfig()
final ImmutableExecutionConfiguration	getExecutionConfig()
final int	getExecutionReplications()
final List<ImmutableExecutionFacet>	getFacets()
final List<ExperimentFacet.SetupFacet<?>>	getSetupConfig()
final int	getSetupReplications()
int	hashCode()	Computes a hash code from attributes: batchConfig, setupConfig, setupReplications, executionConfig, facets, executionReplications.
final boolean	initialisedBatchConfig()	Returns true if the required attribute batchConfig is set.
final boolean	initialisedExecutionConfig()	Returns true if the required attribute executionConfig is set.
final boolean	initialisedExecutionReplications()	Returns true if the required attribute executionReplications is set.
final boolean	initialisedSetupReplications()	Returns true if the required attribute setupReplications is set.
final boolean	isInitialized()	Returns true if all required attributes are set, indicating that the object is initialized.
ModifiableExperimentConfiguration	setBatchConfig(ImmutableBatchConfiguration batchConfig)	Assigns a value to the batchConfig attribute.
ModifiableExperimentConfiguration	setExecutionConfig(ImmutableExecutionConfiguration executionConfig)	Assigns a value to the executionConfig attribute.
ModifiableExperimentConfiguration	setExecutionReplications(int executionReplications)	Assigns a value to the executionReplications attribute.
ModifiableExperimentConfiguration	setFacets(Iterable<? extends ImmutableExecutionFacet> elements)	Sets or replaces all elements for facets list.
ModifiableExperimentConfiguration	setSetupConfig(Iterable<? extends ExperimentFacet.SetupFacet<?>> elements)	Sets or replaces all elements for setupConfig list.
ModifiableExperimentConfiguration	setSetupReplications(int setupReplications)	Assigns a value to the setupReplications attribute.
final ImmutableExperimentConfiguration	toImmutable()	Converts to ImmutableExperimentConfiguration.
String	toString()	Generates a string representation of this ExperimentConfiguration.
final ModifiableExperimentConfiguration	unsetBatchConfig()	Reset an attribute to its initial value.
final ModifiableExperimentConfiguration	unsetExecutionConfig()	Reset an attribute to its initial value.
final ModifiableExperimentConfiguration	unsetExecutionReplications()	Reset an attribute to its initial value.
final ModifiableExperimentConfiguration	unsetSetupReplications()	Reset an attribute to its initial value.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.github.ai4ci.config.ExperimentConfiguration

exporter, getBatchDirectoryPath, getBatchSetupList, getExecution, getSetup, withExecutionConfig, withFacet, withSetupConfig, writeConfig

Method Details

create

public static ModifiableExperimentConfiguration create()

Construct a modifiable instance of ExperimentConfiguration.

Returns:

A new modifiable instance

getBatchConfig

public final ImmutableBatchConfiguration getBatchConfig()

Specified by:

getBatchConfig in interface ExperimentConfiguration

Returns:

value of batchConfig attribute

getSetupConfig

public final List<ExperimentFacet.SetupFacet<?>> getSetupConfig()

Specified by:

getSetupConfig in interface ExperimentConfiguration

Returns:

modifiable list setupConfig

getSetupReplications

public final int getSetupReplications()

Specified by:

getSetupReplications in interface ExperimentConfiguration

Returns:

value of setupReplications attribute

getExecutionConfig

public final ImmutableExecutionConfiguration getExecutionConfig()

Specified by:

getExecutionConfig in interface ExperimentConfiguration

Returns:

value of executionConfig attribute

getFacets

public final List<ImmutableExecutionFacet> getFacets()

Specified by:

getFacets in interface ExperimentConfiguration

Returns:

modifiable list facets

getExecutionReplications

public final int getExecutionReplications()

Specified by:

getExecutionReplications in interface ExperimentConfiguration

Returns:

value of executionReplications attribute

clear

@CanIgnoreReturnValue
public ModifiableExperimentConfiguration clear()

Clears the object by setting all attributes to their initial values.

Returns:

this for use in a chained invocation

from

public ModifiableExperimentConfiguration from(ExperimentConfiguration instance)

Fill this modifiable instance with attribute values from the provided ExperimentConfiguration instance. Regular attribute values will be overridden, i.e. replaced with ones of an instance. Any of the instance's absent optional values will not be copied (will not override current values). Collection elements and entries will be added, not replaced.

Parameters:

instance - The instance from which to copy values

Returns:

this for use in a chained invocation

from

public ModifiableExperimentConfiguration from(ModifiableExperimentConfiguration instance)

Fill this modifiable instance with attribute values from the provided ExperimentConfiguration instance. Regular attribute values will be overridden, i.e. replaced with ones of an instance. Any of the instance's absent optional values will not be copied (will not override current values). Collection elements and entries will be added, not replaced.

Parameters:

instance - The instance from which to copy values

Returns:

this for use in a chained invocation

setBatchConfig

@CanIgnoreReturnValue
public ModifiableExperimentConfiguration setBatchConfig(ImmutableBatchConfiguration batchConfig)

Assigns a value to the batchConfig attribute.

Parameters:

batchConfig - The value for batchConfig

Returns:

this for use in a chained invocation

addSetupConfig

@CanIgnoreReturnValue
public ModifiableExperimentConfiguration addSetupConfig(ExperimentFacet.SetupFacet<?> element)

Adds one element to setupConfig list.

Parameters:

element - The setupConfig element

Returns:

this for use in a chained invocation

addSetupConfig

@SafeVarargs
@CanIgnoreReturnValue
public final ModifiableExperimentConfiguration addSetupConfig(ExperimentFacet.SetupFacet<?>... elements)

Adds elements to setupConfig list.

Parameters:

elements - An array of setupConfig elements

Returns:

this for use in a chained invocation

setSetupConfig

@CanIgnoreReturnValue
public ModifiableExperimentConfiguration setSetupConfig(Iterable<? extends ExperimentFacet.SetupFacet<?>> elements)

Sets or replaces all elements for setupConfig list.

Parameters:

elements - An iterable of setupConfig elements

Returns:

this for use in a chained invocation

addAllSetupConfig

@CanIgnoreReturnValue
public ModifiableExperimentConfiguration addAllSetupConfig(Iterable<? extends ExperimentFacet.SetupFacet<?>> elements)

Adds elements to setupConfig list.

Parameters:

elements - An iterable of setupConfig elements

Returns:

this for use in a chained invocation

setSetupReplications

@CanIgnoreReturnValue
public ModifiableExperimentConfiguration setSetupReplications(int setupReplications)

Assigns a value to the setupReplications attribute.

Parameters:

setupReplications - The value for setupReplications

Returns:

this for use in a chained invocation

setExecutionConfig

@CanIgnoreReturnValue
public ModifiableExperimentConfiguration setExecutionConfig(ImmutableExecutionConfiguration executionConfig)

Assigns a value to the executionConfig attribute.

Parameters:

executionConfig - The value for executionConfig

Returns:

this for use in a chained invocation

addFacet

@CanIgnoreReturnValue
public ModifiableExperimentConfiguration addFacet(ImmutableExecutionFacet element)

Adds one element to facets list.

Parameters:

element - The facets element

Returns:

this for use in a chained invocation

addFacets

@CanIgnoreReturnValue
public final ModifiableExperimentConfiguration addFacets(ImmutableExecutionFacet... elements)

Adds elements to facets list.

Parameters:

elements - An array of facets elements

Returns:

this for use in a chained invocation

setFacets

@CanIgnoreReturnValue
public ModifiableExperimentConfiguration setFacets(Iterable<? extends ImmutableExecutionFacet> elements)

Sets or replaces all elements for facets list.

Parameters:

elements - An iterable of facets elements

Returns:

this for use in a chained invocation

addAllFacets

@CanIgnoreReturnValue
public ModifiableExperimentConfiguration addAllFacets(Iterable<? extends ImmutableExecutionFacet> elements)

Adds elements to facets list.

Parameters:

elements - An iterable of facets elements

Returns:

this for use in a chained invocation

setExecutionReplications

@CanIgnoreReturnValue
public ModifiableExperimentConfiguration setExecutionReplications(int executionReplications)

Assigns a value to the executionReplications attribute.

Parameters:

executionReplications - The value for executionReplications

Returns:

this for use in a chained invocation

initialisedBatchConfig

public final boolean initialisedBatchConfig()

Returns true if the required attribute batchConfig is set.

Returns:

true if set

initialisedSetupReplications

public final boolean initialisedSetupReplications()

Returns true if the required attribute setupReplications is set.

Returns:

true if set

initialisedExecutionConfig

public final boolean initialisedExecutionConfig()

Returns true if the required attribute executionConfig is set.

Returns:

true if set

initialisedExecutionReplications

public final boolean initialisedExecutionReplications()

Returns true if the required attribute executionReplications is set.

Returns:

true if set

unsetBatchConfig

@CanIgnoreReturnValue
public final ModifiableExperimentConfiguration unsetBatchConfig()

Reset an attribute to its initial value.

Returns:

this for use in a chained invocation

unsetSetupReplications

@CanIgnoreReturnValue
public final ModifiableExperimentConfiguration unsetSetupReplications()

Reset an attribute to its initial value.

Returns:

this for use in a chained invocation

unsetExecutionConfig

@CanIgnoreReturnValue
public final ModifiableExperimentConfiguration unsetExecutionConfig()

Reset an attribute to its initial value.

Returns:

this for use in a chained invocation

unsetExecutionReplications

@CanIgnoreReturnValue
public final ModifiableExperimentConfiguration unsetExecutionReplications()

Reset an attribute to its initial value.

Returns:

this for use in a chained invocation

isInitialized

public final boolean isInitialized()

Returns true if all required attributes are set, indicating that the object is initialized.

Returns:

true if set

toImmutable

public final ImmutableExperimentConfiguration toImmutable()

Converts to ImmutableExperimentConfiguration.

Returns:

An immutable instance of ExperimentConfiguration

equals

public boolean equals(@Nullable
 Object another)

This instance is equal to all instances of ModifiableExperimentConfiguration that have equal attribute values. An uninitialized instance is equal only to itself.

Overrides:

equals in class Object

Returns:

true if this is equal to another instance

hashCode

public int hashCode()

Computes a hash code from attributes: batchConfig, setupConfig, setupReplications, executionConfig, facets, executionReplications.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Generates a string representation of this ExperimentConfiguration. If uninitialized, some attribute values may appear as question marks.

Overrides:

toString in class Object

Returns:

A string representation