Package com.tccc.kos.commons.util

Enum Class Mode

java.lang.Object

java.lang.Enum<Mode>

com.tccc.kos.commons.util.Mode

All Implemented Interfaces:

Serializable, Comparable<Mode>, Constable

public enum Mode
extends Enum<Mode>

Enumeration indicating the modes of operation that your kOS application can run in. Currently, there are only two modes: TEST and PROD. The mode is encoded in certificates and KAB files, and therefore allows kOS to determine when to trust artifacts and when not to.

When kOS is running in TEST mode, then artifacts certified either TEST or PROD are trusted, and therefore available to use.

When kOS is running in PROD mode, then only artifacts certified as PROD are trusted, and therefore available to use. In other words, a production system will never trust (and therefore never open or run) an artifact only certified for a TEST system.

Since:

1.0

Version:

2022-08-30

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
PROD
TEST

Method Summary

Modifier and Type	Method	Description
boolean	trust(Mode mode)	Returns true if the current mode trusts the specified mode.
static Mode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Mode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

TEST

public static final Mode TEST

PROD

public static final Mode PROD

Method Details

values

public static Mode[] 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 Mode 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

trust

public boolean trust(Mode mode)

Returns true if the current mode trusts the specified mode.