Package io.github.ai4ci.output

Class ImmutableOutbreakFinalStateCSV

java.lang.Object
io.github.ai4ci.output.ImmutableOutbreakFinalStateCSV
All Implemented Interfaces:
CSVWriter.Writeable, CommonCSV.Execution, CommonCSV.Model, CommonCSV.State, OutbreakFinalStateCSV
@ParametersAreNonnullByDefault @Generated("org.immutables.processor.ProxyProcessor") @Immutable @CheckReturnValue public final class ImmutableOutbreakFinalStateCSV extends Object implements OutbreakFinalStateCSV
Immutable implementation of OutbreakFinalStateCSV.

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

  • Method Details

    • getModelName

      public String getModelName()
      Specified by:
      getModelName in interface CommonCSV.Model
      Returns:
      The value of the modelName attribute

    • getExperimentName

      public String getExperimentName()
      Specified by:
      getExperimentName in interface CommonCSV.Model
      Returns:
      The value of the experimentName attribute

    • getModelReplica

      public int getModelReplica()
      Specified by:
      getModelReplica in interface CommonCSV.Execution
      Returns:
      The value of the modelReplica attribute

    • getExperimentReplica

      public int getExperimentReplica()
      Specified by:
      getExperimentReplica in interface CommonCSV.Execution
      Returns:
      The value of the experimentReplica attribute

    • getTime

      public int getTime()
      Specified by:
      getTime in interface CommonCSV.State
      Returns:
      The value of the time attribute

    • getCumulativeInfections

      public long getCumulativeInfections()
      Specified by:
      getCumulativeInfections in interface OutbreakFinalStateCSV
      Returns:
      The value of the cumulativeInfections attribute

    • getCumulativeAdmissions

      public long getCumulativeAdmissions()
      Specified by:
      getCumulativeAdmissions in interface OutbreakFinalStateCSV
      Returns:
      The value of the cumulativeAdmissions attribute

    • getCumulativeDeaths

      public long getCumulativeDeaths()
      Specified by:
      getCumulativeDeaths in interface OutbreakFinalStateCSV
      Returns:
      The value of the cumulativeDeaths attribute

    • getMaximumPrevalence

      public double getMaximumPrevalence()
      Specified by:
      getMaximumPrevalence in interface OutbreakFinalStateCSV
      Returns:
      The value of the maximumPrevalence attribute

    • getMaximumIncidence

      public long getMaximumIncidence()
      Specified by:
      getMaximumIncidence in interface OutbreakFinalStateCSV
      Returns:
      The value of the maximumIncidence attribute

    • getTimeToMaximumIncidence

      public long getTimeToMaximumIncidence()
      Specified by:
      getTimeToMaximumIncidence in interface OutbreakFinalStateCSV
      Returns:
      The value of the timeToMaximumIncidence attribute

    • getMaximumHospitalBurden

      public long getMaximumHospitalBurden()
      Specified by:
      getMaximumHospitalBurden in interface OutbreakFinalStateCSV
      Returns:
      The value of the maximumHospitalBurden attribute

    • getCumulativeMobilityDecrease

      public double getCumulativeMobilityDecrease()
      Specified by:
      getCumulativeMobilityDecrease in interface OutbreakFinalStateCSV
      Returns:
      The value of the cumulativeMobilityDecrease attribute

    • getCumulativeComplianceDecrease

      public double getCumulativeComplianceDecrease()
      Specified by:
      getCumulativeComplianceDecrease in interface OutbreakFinalStateCSV
      Returns:
      The value of the cumulativeComplianceDecrease attribute

    • withModelName

      public final ImmutableOutbreakFinalStateCSV withModelName(String value)
      Copy the current immutable object by setting a value for the modelName attribute. An equals check used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for modelName
      Returns:
      A modified copy of the this object

    • withExperimentName

      public final ImmutableOutbreakFinalStateCSV withExperimentName(String value)
      Copy the current immutable object by setting a value for the experimentName attribute. An equals check used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for experimentName
      Returns:
      A modified copy of the this object

    • withModelReplica

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

    • withExperimentReplica

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

    • withTime

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

    • withCumulativeInfections

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

    • withCumulativeAdmissions

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

    • withCumulativeDeaths

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

    • withMaximumPrevalence

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

    • withMaximumIncidence

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

    • withTimeToMaximumIncidence

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

    • withMaximumHospitalBurden

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

    • withCumulativeMobilityDecrease

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

    • withCumulativeComplianceDecrease

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

    • equals

      public boolean equals(@Nullable Object another)
      This instance is equal to all instances of ImmutableOutbreakFinalStateCSV 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: modelName, experimentName, modelReplica, experimentReplica, time, cumulativeInfections, cumulativeAdmissions, cumulativeDeaths, maximumPrevalence, maximumIncidence, timeToMaximumIncidence, maximumHospitalBurden, cumulativeMobilityDecrease, cumulativeComplianceDecrease.
      Overrides:
      hashCode in class Object
      Returns:
      hashCode value

    • toString

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

    • copyOf

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

    • toBuilder

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

    • builder

      public static ImmutableOutbreakFinalStateCSV.Builder builder()
      Creates a builder for ImmutableOutbreakFinalStateCSV. 
       ImmutableOutbreakFinalStateCSV.builder()
    .setModelName(String) // required modelName
    .setExperimentName(String) // required experimentName
    .setModelReplica(int) // required modelReplica
    .setExperimentReplica(int) // required experimentReplica
    .setTime(int) // required time
    .setCumulativeInfections(long) // required cumulativeInfections
    .setCumulativeAdmissions(long) // required cumulativeAdmissions
    .setCumulativeDeaths(long) // required cumulativeDeaths
    .setMaximumPrevalence(double) // required maximumPrevalence
    .setMaximumIncidence(long) // required maximumIncidence
    .setTimeToMaximumIncidence(long) // required timeToMaximumIncidence
    .setMaximumHospitalBurden(long) // required maximumHospitalBurden
    .setCumulativeMobilityDecrease(double) // required cumulativeMobilityDecrease
    .setCumulativeComplianceDecrease(double) // required cumulativeComplianceDecrease
    .build();
      Returns:
      A new ImmutableOutbreakFinalStateCSV builder