Module io.jenetics.base
Package io.jenetics

Record Class MutatorResult<T>

java.lang.Object
java.lang.Record
io.jenetics.MutatorResult<T>
Type Parameters:
T - the mutation result type
Record Components:
result - the mutation result
mutations - the number of mutations applied while creating the mutation result
All Implemented Interfaces:
Serializable
public record MutatorResult<T>(T result, int mutations) extends Record implements Serializable
Represents the result pair of one of the four Mutator.mutate calls.
Since:
4.0
Version:
7.0
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    MutatorResult(T result, int mutations)
    Create a new mutation result with the given values.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    int
    mutations()
    Returns the value of the mutations record component.
    T
    result()
    Returns the value of the result record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • MutatorResult

      public MutatorResult(T result, int mutations)
      Create a new mutation result with the given values.
      Parameters:
      result - the mutation result
      mutations - the number of mutations
      Throws:
      IllegalArgumentException - if the given mutations is negative
      NullPointerException - if the given mutation result is null

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • result

      public T result()
      Returns the value of the result record component.
      Returns:
      the value of the result record component

    • mutations

      public int mutations()
      Returns the value of the mutations record component.
      Returns:
      the value of the mutations record component