Package app.portaki.sdk.module.backend

Record Class HostModuleRunResult

java.lang.Object
java.lang.Record
app.portaki.sdk.module.backend.HostModuleRunResult
public record HostModuleRunResult(boolean ok, int succeeded, int failed, int itemsTotal, String summary) extends Record
Résultat générique d'une action backend (compteurs agrégés + résumé lisible humain / logs).

  • Constructor Summary

    Constructors
    Constructor
    Description
    HostModuleRunResult(boolean ok, int succeeded, int failed, int itemsTotal, String summary)
    Creates an instance of a HostModuleRunResult record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static HostModuleRunResult
    emptySuccess()
     
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    int
    failed()
    Returns the value of the failed record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    int
    itemsTotal()
    Returns the value of the itemsTotal record component.
    boolean
    ok()
    Returns the value of the ok record component.
    int
    succeeded()
    Returns the value of the succeeded record component.
    String
    summary()
    Returns the value of the summary 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

    • HostModuleRunResult

      public HostModuleRunResult(boolean ok, int succeeded, int failed, int itemsTotal, String summary)
      Creates an instance of a HostModuleRunResult record class.
      Parameters:
      ok - the value for the ok record component
      succeeded - the value for the succeeded record component
      failed - the value for the failed record component
      itemsTotal - the value for the itemsTotal record component
      summary - the value for the summary record component

  • Method Details

    • emptySuccess

      public static HostModuleRunResult emptySuccess()

    • 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.

    • ok

      public boolean ok()
      Returns the value of the ok record component.
      Returns:
      the value of the ok record component

    • succeeded

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

    • failed

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

    • itemsTotal

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

    • summary

      public String summary()
      Returns the value of the summary record component.
      Returns:
      the value of the summary record component