diff options
| author | Ben Culkin <scorpress@gmail.com> | 2023-06-25 14:59:52 -0400 |
|---|---|---|
| committer | Ben Culkin <scorpress@gmail.com> | 2023-06-25 14:59:52 -0400 |
| commit | c50f997a46cbd2c889a31750f9558847e80aac61 (patch) | |
| tree | 85c942bf77e66876fb822f615afcd23a5cba70ea /base/src/main/java/bjc/utils/cli/TerminalCodes.java | |
| parent | 29db46041115065559a0d42f9a76ebb7c19424ea (diff) | |
Add some documentation
Diffstat (limited to 'base/src/main/java/bjc/utils/cli/TerminalCodes.java')
| -rw-r--r-- | base/src/main/java/bjc/utils/cli/TerminalCodes.java | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/base/src/main/java/bjc/utils/cli/TerminalCodes.java b/base/src/main/java/bjc/utils/cli/TerminalCodes.java index c1d7dfc..7e2206e 100644 --- a/base/src/main/java/bjc/utils/cli/TerminalCodes.java +++ b/base/src/main/java/bjc/utils/cli/TerminalCodes.java @@ -14,14 +14,22 @@ public enum TerminalCodes { // The general idea of the format would be a tab-separated value file, with the // first value being a command, and then the rest being the body of that command. // Would also have the line-continuation feature + /** Alert for starting processing. */ INFO_STARTCOMPROC("IOLPI00001", "STARTING PROCESSING"), + /** Alert for ending processing. */ INFO_ENDCOMPROC("IOLPI00002", "ENDING PROCESSING"), + /** Error for an unknown command */ ERROR_UNRECCOM("IOINE00001", "UNRECOGNIZED COMMAND"), + /** Error for an invalid number format when identifying a reply. */ ERROR_INVREPNO("IOINE00002", "INVALID REPLY NUMBER FORMAT"), + /** Error for specifying an unrecognized reply. */ ERROR_UNKREPNO("IOINE00002", "UNKNOWN REPLY NUMBER"), ; + + /** The code for this error. */ public final String code; + /** The summary message for this error. */ public final String message; private TerminalCodes(String code, String message) { |