Interface PauseReason


public interface PauseReason
Interface that allows objects that are used a reasons for a Pause to be converted to a string that can be used for debugging / reporting.
Since:
1.0
Version:
2024-10-02
  • Method Summary

    Modifier and Type
    Method
    Description
    Return a string representation of this object that is sufficient to describe to a human what the reason is.
  • Method Details

    • getPauseReasonString

      String getPauseReasonString()
      Return a string representation of this object that is sufficient to describe to a human what the reason is. This should not be serialized version of the object. This will typically be used to report why an object is paused so this should return a string suitable for that use case.