Package io.github.ai4ci.config

Class ImmutableWattsStrogatzFacet

java.lang.Object

io.github.ai4ci.config.ImmutableWattsStrogatzFacet

All Implemented Interfaces:

Abstraction.Named, ExperimentFacet.SetupFacet<WattsStrogatzConfiguration>, ExperimentFacet.WattsStrogatzFacet

@ParametersAreNonnullByDefault
@Generated("org.immutables.processor.ProxyProcessor")
@Immutable
@CheckReturnValue
public final class ImmutableWattsStrogatzFacet
extends Object
implements ExperimentFacet.WattsStrogatzFacet

Immutable implementation of ExperimentFacet.WattsStrogatzFacet.

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ImmutableWattsStrogatzFacet.Builder	Builds instances of type ImmutableWattsStrogatzFacet.

Method Summary

Modifier and Type	Method	Description
static ImmutableWattsStrogatzFacet.Builder	builder()	Creates a builder for ImmutableWattsStrogatzFacet.
static ImmutableWattsStrogatzFacet	copyOf(ExperimentFacet.WattsStrogatzFacet instance)	Creates an immutable copy of a ExperimentFacet.WattsStrogatzFacet value.
boolean	equals(Object another)	This instance is equal to all instances of ImmutableWattsStrogatzFacet that have equal attribute values.
ImmutableWattsStrogatzConfiguration	getDefault()
com.google.common.collect.ImmutableList<PartialWattsStrogatzConfiguration>	getModifications()
String	getName()
int	hashCode()	Computes a hash code from attributes: getDefault, name, modifications.
ImmutableWattsStrogatzFacet.Builder	toBuilder()	Creates a builder for ImmutableWattsStrogatzFacet.prefilled with attibute values of this instance to easily create modified copies.
String	toString()	Prints the immutable value WattsStrogatzFacet with attribute values.
final ImmutableWattsStrogatzFacet	withDefault(WattsStrogatzConfiguration value)	Copy the current immutable object by setting a value for the default attribute.
final ImmutableWattsStrogatzFacet	withModifications(PartialWattsStrogatzConfiguration... elements)	Copy the current immutable object with elements that replace the content of modifications.
final ImmutableWattsStrogatzFacet	withModifications(Iterable<? extends PartialWattsStrogatzConfiguration> elements)	Copy the current immutable object with elements that replace the content of modifications.
final ImmutableWattsStrogatzFacet	withName(String value)	Copy the current immutable object by setting a value for the name attribute.

Methods inherited from class java.lang.Object

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

Method Details

getDefault

public ImmutableWattsStrogatzConfiguration getDefault()

Specified by:

getDefault in interface ExperimentFacet.SetupFacet<WattsStrogatzConfiguration>

Returns:

The value of the getDefault attribute

getName

public String getName()

Specified by:

getName in interface Abstraction.Named

Specified by:

getName in interface ExperimentFacet.SetupFacet<WattsStrogatzConfiguration>

Returns:

The value of the name attribute

getModifications

public com.google.common.collect.ImmutableList<PartialWattsStrogatzConfiguration> getModifications()

Specified by:

getModifications in interface ExperimentFacet.SetupFacet<WattsStrogatzConfiguration>

Specified by:

getModifications in interface ExperimentFacet.WattsStrogatzFacet

Returns:

The value of the modifications attribute

withDefault

public final ImmutableWattsStrogatzFacet withDefault(WattsStrogatzConfiguration value)

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

Parameters:

value - A new value for getDefault

Returns:

A modified copy of the this object

withName

public final ImmutableWattsStrogatzFacet withName(String value)

Copy the current immutable object by setting a value for the name attribute. An equals check used to prevent copying of the same value by returning this.

Parameters:

value - A new value for name

Returns:

A modified copy of the this object

withModifications

public final ImmutableWattsStrogatzFacet withModifications(PartialWattsStrogatzConfiguration... elements)

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

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withModifications

public final ImmutableWattsStrogatzFacet withModifications(Iterable<? extends PartialWattsStrogatzConfiguration> elements)

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

Parameters:

elements - An iterable of modifications elements to set

Returns:

A modified copy of this object

equals

public boolean equals(@Nullable
 Object another)

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

Overrides:

equals in class Object

Returns:

true if this is equal to another instance

hashCode

public int hashCode()

Computes a hash code from attributes: getDefault, name, modifications.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value WattsStrogatzFacet with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutableWattsStrogatzFacet copyOf(ExperimentFacet.WattsStrogatzFacet instance)

Creates an immutable copy of a ExperimentFacet.WattsStrogatzFacet 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 WattsStrogatzFacet instance

toBuilder

public ImmutableWattsStrogatzFacet.Builder toBuilder()

Creates a builder for ImmutableWattsStrogatzFacet.prefilled with attibute values of this instance to easily create modified copies.

Returns:

A new ImmutableWattsStrogatzFacet builder with attributes of this instance

builder

public static ImmutableWattsStrogatzFacet.Builder builder()

Creates a builder for ImmutableWattsStrogatzFacet.

 ImmutableWattsStrogatzFacet.builder()
    .setDefault(io.github.ai4ci.config.setup.WattsStrogatzConfiguration) // required default
    .setName(String) // optional name
    .addModification|addAllModifications(io.github.ai4ci.config.setup.PartialWattsStrogatzConfiguration) // modifications elements
    .build();
 

Returns:

A new ImmutableWattsStrogatzFacet builder