Package net.bmahe.genetics4j.gp.spec.mutation

Class ImmutableRule

java.lang.Object

net.bmahe.genetics4j.gp.spec.mutation.ImmutableRule

All Implemented Interfaces:

Rule

@Generated(from="Rule",
           generator="Immutables")
@Generated("org.immutables.processor.ProxyProcessor")
public final class ImmutableRule
extends Object
implements Rule

Immutable implementation of Rule.

Use the builder to create immutable instances: ImmutableRule.builder(). Use the static factory method to create immutable instances: ImmutableRule.of().

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
private final BiFunction<Program,TreeNode<Operation<?>>,TreeNode<Operation<?>>>	applicator
private final Predicate<TreeNode<Operation<?>>>	predicate

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ImmutableRule(Predicate<TreeNode<Operation<?>>> predicate, BiFunction<Program,TreeNode<Operation<?>>,TreeNode<Operation<?>>> applicator)
private	ImmutableRule(ImmutableRule original, Predicate<TreeNode<Operation<?>>> predicate, BiFunction<Program,TreeNode<Operation<?>>,TreeNode<Operation<?>>> applicator)

Method Summary

Modifier and Type	Method	Description
BiFunction<Program,TreeNode<Operation<?>>,TreeNode<Operation<?>>>	applicator()
static ImmutableRule.Builder	builder()	Creates a builder for Rule.
static Rule	copyOf(Rule instance)	Creates an immutable copy of a Rule value.
boolean	equals(Object another)	This instance is equal to all instances of ImmutableRule that have equal attribute values.
private boolean	equalsByValue(ImmutableRule another)
int	hashCode()	Computes a hash code from attributes: predicate, applicator.
static Rule	of(Predicate<TreeNode<Operation<?>>> predicate, BiFunction<Program,TreeNode<Operation<?>>,TreeNode<Operation<?>>> applicator)	Construct a new immutable Rule instance.
Predicate<TreeNode<Operation<?>>>	predicate()
String	toString()	Prints the immutable value Rule with attribute values.
final ImmutableRule	withApplicator(BiFunction<Program,TreeNode<Operation<?>>,TreeNode<Operation<?>>> value)	Copy the current immutable object by setting a value for the applicator attribute.
final ImmutableRule	withPredicate(Predicate<TreeNode<Operation<?>>> value)	Copy the current immutable object by setting a value for the predicate attribute.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.bmahe.genetics4j.gp.spec.mutation.Rule

apply, test

Field Details

predicate

private final Predicate<TreeNode<Operation<?>>> predicate

applicator

private final BiFunction<Program,TreeNode<Operation<?>>,TreeNode<Operation<?>>> applicator

Constructor Details

ImmutableRule

private ImmutableRule(Predicate<TreeNode<Operation<?>>> predicate,
 BiFunction<Program,TreeNode<Operation<?>>,TreeNode<Operation<?>>> applicator)

ImmutableRule

private ImmutableRule(ImmutableRule original,
 Predicate<TreeNode<Operation<?>>> predicate,
 BiFunction<Program,TreeNode<Operation<?>>,TreeNode<Operation<?>>> applicator)

Method Details

predicate

public Predicate<TreeNode<Operation<?>>> predicate()

Specified by:

predicate in interface Rule

Returns:

The value of the predicate attribute

applicator

public BiFunction<Program,TreeNode<Operation<?>>,TreeNode<Operation<?>>> applicator()

Specified by:

applicator in interface Rule

Returns:

The value of the applicator attribute

withPredicate

public final ImmutableRule withPredicate(Predicate<TreeNode<Operation<?>>> value)

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

Parameters:

value - A new value for predicate

Returns:

A modified copy or the this object

withApplicator

public final ImmutableRule withApplicator(BiFunction<Program,TreeNode<Operation<?>>,TreeNode<Operation<?>>> value)

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

Parameters:

value - A new value for applicator

Returns:

A modified copy or the this object

equals

public boolean equals(Object another)

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

Overrides:

equals in class Object

Returns:

true if this is equal to another instance

equalsByValue

private boolean equalsByValue(ImmutableRule another)

hashCode

public int hashCode()

Computes a hash code from attributes: predicate, applicator.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value Rule with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static Rule of(Predicate<TreeNode<Operation<?>>> predicate,
 BiFunction<Program,TreeNode<Operation<?>>,TreeNode<Operation<?>>> applicator)

Construct a new immutable Rule instance.

Parameters:

predicate - The value for the predicate attribute

applicator - The value for the applicator attribute

Returns:

An immutable Rule instance

copyOf

public static Rule copyOf(Rule instance)

Creates an immutable copy of a Rule 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 Rule instance

builder

public static ImmutableRule.Builder builder()

Creates a builder for Rule.

 ImmutableRule.builder()
    .predicate(function.Predicate<net.bmahe.genetics4j.core.chromosomes.TreeNode<net.bmahe.genetics4j.gp.Operation<?>>>) // required predicate
    .applicator(function.BiFunction<net.bmahe.genetics4j.gp.program.Program, net.bmahe.genetics4j.core.chromosomes.TreeNode<net.bmahe.genetics4j.gp.Operation<?>>, net.bmahe.genetics4j.core.chromosomes.TreeNode<net.bmahe.genetics4j.gp.Operation<?>>>) // required applicator
    .build();
 

Returns:

A new Rule builder