Package io.github.ai4ci.util

Class ImmutableFixedValueFunction

java.lang.Object
io.github.ai4ci.util.ImmutableFixedValueFunction
All Implemented Interfaces:
Abstraction.SimpleFunction, FixedValueFunction, Serializable
@ParametersAreNonnullByDefault @Generated("org.immutables.processor.ProxyProcessor") @Immutable @CheckReturnValue public final class ImmutableFixedValueFunction extends Object implements FixedValueFunction
Immutable implementation of FixedValueFunction.

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

See Also:

  • Method Details

    • getValue

      public double getValue()
      Specified by:
      getValue in interface FixedValueFunction
      Returns:
      The value of the value attribute

    • withValue

      public final ImmutableFixedValueFunction withValue(double value)
      Copy the current immutable object by setting a value for the value attribute. A value strict bits equality used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for value
      Returns:
      A modified copy of the this object

    • equals

      public boolean equals(@Nullable Object another)
      This instance is equal to all instances of ImmutableFixedValueFunction 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: value.
      Overrides:
      hashCode in class Object
      Returns:
      hashCode value

    • toString

      public String toString()
      Prints the immutable value FixedValueFunction with attribute values.
      Overrides:
      toString in class Object
      Returns:
      A string representation of the value

    • copyOf

      public static ImmutableFixedValueFunction copyOf(FixedValueFunction instance)
      Creates an immutable copy of a FixedValueFunction 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 FixedValueFunction instance

    • toBuilder

      public ImmutableFixedValueFunction.Builder toBuilder()
      Creates a builder for ImmutableFixedValueFunction.prefilled with attibute values of this instance to easily create modified copies.
      Returns:
      A new ImmutableFixedValueFunction builder with attributes of this instance

    • builder

      public static ImmutableFixedValueFunction.Builder builder()
      Creates a builder for ImmutableFixedValueFunction. 
       ImmutableFixedValueFunction.builder()
    .setValue(double) // required value
    .build();
      Returns:
      A new ImmutableFixedValueFunction builder