Package com.io7m.brooklime.api

Class BLProgressFileStarted

java.lang.Object
com.io7m.brooklime.api.BLProgressFileStarted
All Implemented Interfaces:
BLProgressEventType, BLProgressEventType.BLProgressFileStartedType
public final class BLProgressFileStarted
extends java.lang.Object
implements BLProgressEventType.BLProgressFileStartedType
Immutable implementation of BLProgressEventType.BLProgressFileStartedType.

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

  • Method Details

    • name

      public java.lang.String name()
      Specified by:
      name in interface BLProgressEventType
      Specified by:
      name in interface BLProgressEventType.BLProgressFileStartedType
      Returns:
      The value of the name attribute

    • attemptCurrent

      public int attemptCurrent()
      Specified by:
      attemptCurrent in interface BLProgressEventType
      Specified by:
      attemptCurrent in interface BLProgressEventType.BLProgressFileStartedType
      Returns:
      The value of the attemptCurrent attribute

    • attemptMaximum

      public int attemptMaximum()
      Specified by:
      attemptMaximum in interface BLProgressEventType
      Specified by:
      attemptMaximum in interface BLProgressEventType.BLProgressFileStartedType
      Returns:
      The value of the attemptMaximum attribute

    • fileIndexCurrent

      public int fileIndexCurrent()
      Specified by:
      fileIndexCurrent in interface BLProgressEventType
      Specified by:
      fileIndexCurrent in interface BLProgressEventType.BLProgressFileStartedType
      Returns:
      The value of the fileIndexCurrent attribute

    • fileIndexMaximum

      public int fileIndexMaximum()
      Specified by:
      fileIndexMaximum in interface BLProgressEventType
      Specified by:
      fileIndexMaximum in interface BLProgressEventType.BLProgressFileStartedType
      Returns:
      The value of the fileIndexMaximum attribute

    • withName

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

    • withAttemptCurrent

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

    • withAttemptMaximum

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

    • withFileIndexCurrent

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

    • withFileIndexMaximum

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

    • equals

      public boolean equals​(java.lang.Object another)
      This instance is equal to all instances of BLProgressFileStarted that have equal attribute values.
      Overrides:
      equals in class java.lang.Object
      Returns:
      true if this is equal to another instance

    • hashCode

      public int hashCode()
      Computes a hash code from attributes: name, attemptCurrent, attemptMaximum, fileIndexCurrent, fileIndexMaximum.
      Overrides:
      hashCode in class java.lang.Object
      Returns:
      hashCode value

    • toString

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

    • copyOf

      public static BLProgressFileStarted copyOf​(BLProgressEventType.BLProgressFileStartedType instance)
      Creates an immutable copy of a BLProgressEventType.BLProgressFileStartedType 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 BLProgressFileStarted instance

    • builder

      public static BLProgressFileStarted.Builder builder()
      Creates a builder for BLProgressFileStarted. 
       BLProgressFileStarted.builder()
    .setName(String) // required name
    .setAttemptCurrent(int) // required attemptCurrent
    .setAttemptMaximum(int) // required attemptMaximum
    .setFileIndexCurrent(int) // required fileIndexCurrent
    .setFileIndexMaximum(int) // required fileIndexMaximum
    .build();
      Returns:
      A new BLProgressFileStarted builder