SysExits (spf4j 8.5.26-SNAPSHOT API)

java.lang.Object
- java.lang.Enum<SysExits>
- - org.spf4j.base.SysExits

All Implemented Interfaces:

Serializable, Comparable<SysExits>
```
public enum SysExits
extends Enum<SysExits>
```
some "standard" process exit codes from: http://tldp.org/LDP/abs/html/index.html https://www.freebsd.org/cgi/man.cgi?query=sysexits&apropos=0&sektion=0&manpath=FreeBSD+4.3-RELEASE&format=html http://journal.thobe.org/2013/02/jvms-and-kill-signals.html

Author:

zoly

Enum Constant Summary

Enum Constants
Enum Constant and Description
`EX_CANNOT_EXEC_CMD` cannot execute invoked command.
`EX_CANTCREAT` A (user specified) output file cannot be created.
`EX_CMD_NOT_FOUND` Command not found.
`EX_CONFIG` Something was found in an unconfigured or misconfigured state.
`EX_DATAERR` The input data was incorrect in some way.
`EX_GENERAL` Catch all for general errors.
`EX_INVALID_ARG_TO_EXIT` Invalid argument to exit.
`EX_IOERR` An error occurred while doing I/O on some file.
`EX_NOHOST` The host specified did not exist.
`EX_NOINPUT` An input file (not a system file) did not exist or was not readable.
`EX_NOPERM` You did not have sufficient permission to perform the operation.
`EX_NOUSER` The user specified did not exist.
`EX_OSERR` An operating system error has been detected.
`EX_OSFILE` Some system file (e.g., /etc/passwd, /var/run/utmp,etc.) does not exist, cannot be opened, or has some sort of error (e.g., syntax error).
`EX_PROTOCOL` The remote system returned something that was ``not possible'' during a protocol exchange.
`EX_SHELL_BUILTIN_MISSUSE` Shell build in miss-use.
`EX_SIG_10`
`EX_SIG_11`
`EX_SIG_12`
`EX_SIG_16`
`EX_SIG_17`
`EX_SIG_18`
`EX_SIG_19`
`EX_SIG_20`
`EX_SIG_21`
`EX_SIG_22`
`EX_SIG_23`
`EX_SIG_24`
`EX_SIG_25`
`EX_SIG_26`
`EX_SIG_27`
`EX_SIG_28`
`EX_SIG_29`
`EX_SIG_30`
`EX_SIG_31`
`EX_SIG_7`
`EX_SIG_ABRT`
`EX_SIG_ALRM`
`EX_SIG_FPE`
`EX_SIG_HUP` Section caused by exit due to signal.
`EX_SIG_ILL`
`EX_SIG_INT`
`EX_SIG_KILL`
`EX_SIG_PIPE`
`EX_SIG_QUIT`
`EX_SIG_TERM`
`EX_SIG_TRAP`
`EX_SOFTWARE` An internal software error has been detected.
`EX_STATUS_OUT_OF_RANGE`
`EX_TEMPFAIL` Temporary failure, indicating something that is not really an error.
`EX_UNAVAILABLE` A service is unavailable.
`EX_UNKNOWN` Any return codes not explicitly defined will be associated with "EX_UNKNOWN"
`EX_USAGE` The command was used incorrectly, e.g., with the wrong number of arguments, a bad flag, a bad syntax in a parameter, or whatever.
`OK` Everything is OK.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`exitCode()`
`static SysExits`	`fromCode(int exitCode)`
`boolean`	`isError()`
`boolean`	`isOk()`
`static SysExits`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static SysExits[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - OK
```
public static final SysExits OK
```
    Everything is OK.
  - EX_GENERAL
```
public static final SysExits EX_GENERAL
```
    Catch all for general errors.
  - EX_SHELL_BUILTIN_MISSUSE
```
public static final SysExits EX_SHELL_BUILTIN_MISSUSE
```
    Shell build in miss-use.
  - EX_USAGE
```
public static final SysExits EX_USAGE
```
    The command was used incorrectly, e.g., with the wrong number of arguments, a bad flag, a bad syntax in a parameter, or whatever.
  - EX_DATAERR
```
public static final SysExits EX_DATAERR
```
    The input data was incorrect in some way. This should only be used for user's data and not system files.
  - EX_NOINPUT
```
public static final SysExits EX_NOINPUT
```
    An input file (not a system file) did not exist or was not readable. This could also include errors like ``No message'' to a mailer (if it cared to catch it).
  - EX_NOUSER
```
public static final SysExits EX_NOUSER
```
    The user specified did not exist. This might be used for mail addresses or remote logins.
  - EX_NOHOST
```
public static final SysExits EX_NOHOST
```
    The host specified did not exist. This is used in mail addresses or network requests.
  - EX_UNAVAILABLE
```
public static final SysExits EX_UNAVAILABLE
```
    A service is unavailable. This can occur if a support program or file does not exist. This can also be used as a catchall message when something you wanted to do doesn't work, but you don't know why.
  - EX_SOFTWARE
```
public static final SysExits EX_SOFTWARE
```
    An internal software error has been detected. This should be limited to non-operating system related errors as possible.
  - EX_OSERR
```
public static final SysExits EX_OSERR
```
    An operating system error has been detected. This is intended to be used for such things as ``cannot fork'', ``cannot create pipe'', or the like. It includes things like getuid returning a user that does not exist in the passwd file.
  - EX_OSFILE
```
public static final SysExits EX_OSFILE
```
    Some system file (e.g., /etc/passwd, /var/run/utmp,etc.) does not exist, cannot be opened, or has some sort of error (e.g., syntax error).
  - EX_CANTCREAT
```
public static final SysExits EX_CANTCREAT
```
    A (user specified) output file cannot be created.
  - EX_IOERR
```
public static final SysExits EX_IOERR
```
    An error occurred while doing I/O on some file.
  - EX_TEMPFAIL
```
public static final SysExits EX_TEMPFAIL
```
    Temporary failure, indicating something that is not really an error. In sendmail, this means that a mailer (e.g.) could not create a connection, and the request should be reattempted later.
  - EX_PROTOCOL
```
public static final SysExits EX_PROTOCOL
```
    The remote system returned something that was ``not possible'' during a protocol exchange.
  - EX_NOPERM
```
public static final SysExits EX_NOPERM
```
    You did not have sufficient permission to perform the operation. This is not intended for file system problems, which should use EX_NOINPUT or EX_CANTCREAT, but rather for higher level permissions.
  - EX_CONFIG
```
public static final SysExits EX_CONFIG
```
    Something was found in an unconfigured or misconfigured state.
  - EX_CANNOT_EXEC_CMD
```
public static final SysExits EX_CANNOT_EXEC_CMD
```
    cannot execute invoked command.
  - EX_CMD_NOT_FOUND
```
public static final SysExits EX_CMD_NOT_FOUND
```
    Command not found.
  - EX_INVALID_ARG_TO_EXIT
```
public static final SysExits EX_INVALID_ARG_TO_EXIT
```
    Invalid argument to exit.
  - EX_SIG_HUP
```
public static final SysExits EX_SIG_HUP
```
    Section caused by exit due to signal. where signal name is same on Linux, Solaris and MacOS enum has the appropriate name. for linux see: http://man7.org/linux/man-pages/man7/signal.7.html or run man signal on you OS of choice.
  - EX_SIG_INT
```
public static final SysExits EX_SIG_INT
```
  - EX_SIG_QUIT
```
public static final SysExits EX_SIG_QUIT
```
  - EX_SIG_ILL
```
public static final SysExits EX_SIG_ILL
```
  - EX_SIG_TRAP
```
public static final SysExits EX_SIG_TRAP
```
  - EX_SIG_ABRT
```
public static final SysExits EX_SIG_ABRT
```
  - EX_SIG_7
```
public static final SysExits EX_SIG_7
```
  - EX_SIG_FPE
```
public static final SysExits EX_SIG_FPE
```
  - EX_SIG_KILL
```
public static final SysExits EX_SIG_KILL
```
  - EX_SIG_10
```
public static final SysExits EX_SIG_10
```
  - EX_SIG_11
```
public static final SysExits EX_SIG_11
```
  - EX_SIG_12
```
public static final SysExits EX_SIG_12
```
  - EX_SIG_PIPE
```
public static final SysExits EX_SIG_PIPE
```
  - EX_SIG_ALRM
```
public static final SysExits EX_SIG_ALRM
```
  - EX_SIG_TERM
```
public static final SysExits EX_SIG_TERM
```
  - EX_SIG_16
```
public static final SysExits EX_SIG_16
```
  - EX_SIG_17
```
public static final SysExits EX_SIG_17
```
  - EX_SIG_18
```
public static final SysExits EX_SIG_18
```
  - EX_SIG_19
```
public static final SysExits EX_SIG_19
```
  - EX_SIG_20
```
public static final SysExits EX_SIG_20
```
  - EX_SIG_21
```
public static final SysExits EX_SIG_21
```
  - EX_SIG_22
```
public static final SysExits EX_SIG_22
```
  - EX_SIG_23
```
public static final SysExits EX_SIG_23
```
  - EX_SIG_24
```
public static final SysExits EX_SIG_24
```
  - EX_SIG_25
```
public static final SysExits EX_SIG_25
```
  - EX_SIG_26
```
public static final SysExits EX_SIG_26
```
  - EX_SIG_27
```
public static final SysExits EX_SIG_27
```
  - EX_SIG_28
```
public static final SysExits EX_SIG_28
```
  - EX_SIG_29
```
public static final SysExits EX_SIG_29
```
  - EX_SIG_30
```
public static final SysExits EX_SIG_30
```
  - EX_SIG_31
```
public static final SysExits EX_SIG_31
```
  - EX_STATUS_OUT_OF_RANGE
```
public static final SysExits EX_STATUS_OUT_OF_RANGE
```
  - EX_UNKNOWN
```
public static final SysExits EX_UNKNOWN
```
    Any return codes not explicitly defined will be associated with "EX_UNKNOWN"
- Method Detail
  - values
```
public static SysExits[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (SysExits c : SysExits.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static SysExits valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - exitCode
```
public int exitCode()
```
  - isOk
```
public boolean isOk()
```
  - isError
```
public boolean isError()
```
  - fromCode
```
@Nonnull
public static SysExits fromCode(int exitCode)
```
    Parameters:
    
    exitCode -
    
    Returns:
    
    corresponding enum.

Enum SysExits

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

OK

EX_GENERAL

EX_SHELL_BUILTIN_MISSUSE

EX_USAGE

EX_DATAERR

EX_NOINPUT

EX_NOUSER

EX_NOHOST

EX_UNAVAILABLE

EX_SOFTWARE

EX_OSERR

EX_OSFILE

EX_CANTCREAT

EX_IOERR

EX_TEMPFAIL

EX_PROTOCOL

EX_NOPERM

EX_CONFIG

EX_CANNOT_EXEC_CMD

EX_CMD_NOT_FOUND

EX_INVALID_ARG_TO_EXIT

EX_SIG_HUP

EX_SIG_INT

EX_SIG_QUIT

EX_SIG_ILL

EX_SIG_TRAP

EX_SIG_ABRT

EX_SIG_7

EX_SIG_FPE

EX_SIG_KILL

EX_SIG_10

EX_SIG_11

EX_SIG_12

EX_SIG_PIPE

EX_SIG_ALRM

EX_SIG_TERM

EX_SIG_16

EX_SIG_17

EX_SIG_18

EX_SIG_19

EX_SIG_20

EX_SIG_21

EX_SIG_22

EX_SIG_23

EX_SIG_24

EX_SIG_25

EX_SIG_26

EX_SIG_27

EX_SIG_28

EX_SIG_29

EX_SIG_30

EX_SIG_31

EX_STATUS_OUT_OF_RANGE

EX_UNKNOWN

Method Detail

values

valueOf

exitCode

isOk

isError

fromCode