Enum Class CliExitCode

java.lang.Object

java.lang.Enum<CliExitCode>

dev.archunitjava.cli.CliExitCode

All Implemented Interfaces:

Serializable, Comparable<CliExitCode>, Constable

public enum CliExitCode
extends Enum<CliExitCode>

Stable process outcomes shared by all CLI entry points and build integrations.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ANALYSIS_ERROR
INVALID_CONFIGURATION
POLICY_VIOLATION
SUCCESS
USAGE

Method Summary

Modifier and Type	Method	Description
int	code()
String	description()
static String	documentation()
static CliExitCode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CliExitCode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SUCCESS

public static final CliExitCode SUCCESS

USAGE

public static final CliExitCode USAGE

INVALID_CONFIGURATION

public static final CliExitCode INVALID_CONFIGURATION

ANALYSIS_ERROR

public static final CliExitCode ANALYSIS_ERROR

POLICY_VIOLATION

public static final CliExitCode POLICY_VIOLATION

Method Details

values

public static CliExitCode[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static CliExitCode valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

code

public int code()

description

public String description()

documentation

public static String documentation()