Annotation Interface ExitCodes


@Retention(RUNTIME) @Target(TYPE) @Documented public @interface ExitCodes
Annotation that indicates the exit codes section for a commands help
  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    int[]
    The exit codes that this command may return, meanings of the exit codes may be given using the descriptions() property.
    Descriptions of the meanings of the exit codes this command may return, the exit codes are given by the codes() property.
  • Element Details

    • codes

      int[] codes
      The exit codes that this command may return, meanings of the exit codes may be given using the descriptions() property. The data in these two properties is collated based on array indices.
      Returns:
      Array of exit codes
      Default:
      {}
    • descriptions

      String[] descriptions
      Descriptions of the meanings of the exit codes this command may return, the exit codes are given by the codes() property. The data in these two properties is collated based on array indices.
      Returns:
      Exit Codes descriptions
      Default:
      {}