Record Class RenameResult

java.lang.Object
java.lang.Record
de.aikiit.fotorenamer.image.RenameResult
public record RenameResult(int total, int processed, int renamed, int skipped, int failed, boolean cancelled) extends Record
Immutable batch result (or progress snapshot), without localized UI text. Total counts detected image candidates; processed is renamed + skipped + failed. Cancelled batches can have unprocessed candidates. Completed moves are not rolled back.

  • Constructor Summary

    Constructors
    Constructor
    Description
    RenameResult(int total, int processed, int renamed, int skipped, int failed, boolean cancelled)
    Creates an instance of a RenameResult record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    cancelled()
    Returns the value of the cancelled record component.
    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
    processed()
    Returns the value of the processed record component.
    int
    renamed()
    Returns the value of the renamed record component.
    int
    skipped()
    Returns the value of the skipped record component.
    final String
    toString()
    Returns a string representation of this record class.
    int
    total()
    Returns the value of the total record component.

    Methods inherited from class Object

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

  • Constructor Details

    • RenameResult

      public RenameResult(int total, int processed, int renamed, int skipped, int failed, boolean cancelled)
      Creates an instance of a RenameResult record class.
      Parameters:
      total - the value for the total record component
      processed - the value for the processed record component
      renamed - the value for the renamed record component
      skipped - the value for the skipped record component
      failed - the value for the failed record component
      cancelled - the value for the cancelled record component

  • 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. All components in this record class are compared with the compare method from their corresponding wrapper classes.
      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.

    • total

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

    • processed

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

    • renamed

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

    • skipped

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

    • failed

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

    • cancelled

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