类 ExitStatus

字段详细资料

• UNKNOWN

  public static final ExitStatus UNKNOWN

  Convenient constant value representing unknown state - assumed not continuable.

• EXECUTING

  public static final ExitStatus EXECUTING

  Convenient constant value representing continuable state where processing is still taking place, so no further action is required. Used for asynchronous execution scenarios where the processing is happening in another thread or process and the caller is not required to wait for the result.

• COMPLETED

  public static final ExitStatus COMPLETED

  Convenient constant value representing finished processing.

• NOOP

  public static final ExitStatus NOOP

  Convenient constant value representing job that did no processing (e.g. because it was already complete).

• FAILED

  public static final ExitStatus FAILED

  Convenient constant value representing finished processing with an error.

• STOPPED

  public static final ExitStatus STOPPED

  Convenient constant value representing finished processing with interrupted status.

构造器详细资料

• ExitStatus

  public ExitStatus​(java.lang.String exitCode)

• ExitStatus

  public ExitStatus​(java.lang.String exitCode,
                    java.lang.String exitDescription)

方法详细资料

• getExitCode

  public java.lang.String getExitCode()

  Getter for the exit code (defaults to blank).

  返回:

  the exit code.

• getExitDescription

  public java.lang.String getExitDescription()

  Getter for the exit description (defaults to blank)

  返回:

  String containing the exit description.

• and

  public ExitStatus and​(ExitStatus status)

  Create a new ExitStatus with a logical combination of the exit code, and a concatenation of the descriptions. If either value has a higher severity then its exit code will be used in the result. In the case of equal severity, the exit code is replaced if the new value is alphabetically greater.
  
  Severity is defined by the exit code:

  • Codes beginning with EXECUTING have severity 1
  • Codes beginning with COMPLETED have severity 2
  • Codes beginning with NOOP have severity 3
  • Codes beginning with STOPPED have severity 4
  • Codes beginning with FAILED have severity 5
  • Codes beginning with UNKNOWN have severity 6

  Others have severity 7, so custom exit codes always win.
  If the input is null just return this.

  参数:

  status - an ExitStatus to combine with this one.

  返回:

  a new ExitStatus combining the current value and the argument provided.

• compareTo

  public int compareTo​(ExitStatus status)

  指定者:

  compareTo 在接口中 java.lang.Comparable<ExitStatus>

  参数:

  status - an ExitStatus to compare

  返回:

  greater than zero, 0, less than zero according to the severity and exit code

  另请参阅:

  Comparable

• toString

  public java.lang.String toString()

  覆盖:

  toString 在类中 java.lang.Object

• equals

  public boolean equals​(java.lang.Object obj)

  Compare the fields one by one.

  覆盖:

  equals 在类中 java.lang.Object

  另请参阅:

  Object.equals(java.lang.Object)

• hashCode

  public int hashCode()

  Compatible with the equals implementation.

  覆盖:

  hashCode 在类中 java.lang.Object

  另请参阅:

  Object.hashCode()

• replaceExitCode

  public ExitStatus replaceExitCode​(java.lang.String code)

  Add an exit code to an existing ExitStatus. If there is already a code present tit will be replaced.

  参数:

  code - the code to add

  返回:

  a new ExitStatus with the same properties but a new exit code.

• isRunning

  public boolean isRunning()

  Check if this status represents a running process.

  返回:

  true if the exit code is "EXECUTING" or "UNKNOWN"

• addExitDescription

  public ExitStatus addExitDescription​(java.lang.String description)

  Add an exit description to an existing ExitStatus. If there is already a description present the two will be concatenated with a semicolon.

  参数:

  description - the description to add

  返回:

  a new ExitStatus with the same properties but a new exit description

• addExitDescription

  public ExitStatus addExitDescription​(java.lang.Throwable throwable)

  Extract the stack trace from the throwable provided and append it to the exist description.

  参数:

  throwable - Throwable instance containing the stack trace.

  返回:

  a new ExitStatus with the stack trace appended

• isNonDefaultExitStatus

  public static boolean isNonDefaultExitStatus​(ExitStatus status)

  参数:

  status - the exit code to be evaluated

  返回:

  true if the value matches a known exit code