Package org.spdx.tools

Class ExitCode

java.lang.Object

org.spdx.tools.ExitCode

public class ExitCode
extends Object

Shared process exit status codes for the command line tools.
Individual tools are free to only use a subset of these - e.g. a tool with no document-level validity concept may only ever return SUCCESS or ERROR.
Values match the CommandLine.ExitCode constants used by picocli, a common Java CLI framework (OK=0, SOFTWARE=1, USAGE=2).

Author:

Arthit Suriyawongkul

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ERROR	The command failed - e.g. the SPDX document is invalid, or could not be read/parsed.
static final int	SUCCESS	The command completed successfully.
static final int	USAGE_ERROR	The command was invoked incorrectly - e.g. missing or invalid arguments.

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

SUCCESS

public static final int SUCCESS

The command completed successfully.

See Also:

• Constant Field Values

ERROR

public static final int ERROR

The command failed - e.g. the SPDX document is invalid, or could not be read/parsed.

See Also:

• Constant Field Values

USAGE_ERROR

public static final int USAGE_ERROR

The command was invoked incorrectly - e.g. missing or invalid arguments.

See Also:

• Constant Field Values