Package io.github.ai4ci.config.riskmodel

Class ImmutableRiskKernelProvided

java.lang.Object
io.github.ai4ci.config.riskmodel.ImmutableRiskKernelProvided
All Implemented Interfaces:
RiskKernelConfiguration, RiskKernelProvided, Serializable
@ParametersAreNonnullByDefault @Generated("org.immutables.processor.ProxyProcessor") @Immutable @CheckReturnValue public final class ImmutableRiskKernelProvided extends Object implements RiskKernelProvided
Immutable implementation of RiskKernelProvided.

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

See Also:

  • Method Details

    • getOffset

      public int getOffset()
      Specified by:
      getOffset in interface RiskKernelProvided
      Returns:
      The value of the offset attribute

    • getDensity

      public double[] getDensity()
      Specified by:
      getDensity in interface RiskKernelProvided
      Returns:
      A cloned density array

    • withOffset

      public final ImmutableRiskKernelProvided withOffset(int value)
      Copy the current immutable object by setting a value for the offset attribute. A value equality check is used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for offset
      Returns:
      A modified copy of the this object

    • withDensity

      public final ImmutableRiskKernelProvided withDensity(double... elements)
      Copy the current immutable object with elements that replace the content of density. The array is cloned before being saved as attribute values.
      Parameters:
      elements - The non-null elements for density
      Returns:
      A modified copy of this object

    • equals

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

    • toString

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

    • copyOf

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

    • toBuilder

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

    • builder

      public static ImmutableRiskKernelProvided.Builder builder()
      Creates a builder for ImmutableRiskKernelProvided. 
       ImmutableRiskKernelProvided.builder()
    .setOffset(int) // required offset
    .setDensity(double) // required density
    .build();
      Returns:
      A new ImmutableRiskKernelProvided builder