Argos/onl.ycode.argos/ValueSource

ValueSource

enum ValueSource : Enum<ValueSource> (source)

Enum representing the source of a value for an Argos-managed property.

This allows users to determine whether a value came from user input, default specification, environment variable, or is missing.

Entries

USER

Value was provided by the user via command line arguments. This is the highest priority source.

DEFAULT

Value was set from a default value specified via .default(). This is used when no user input or environment variable is provided.

ENVIRONMENT

Value was read from an environment variable specified via .fromEnv(). This is used when no user input is provided but an environment variable exists.

MISSING

No value was provided from any source. This is used for nullable options that have no user input, environment variable, or default.

Properties

entries

val entries: EnumEntries<ValueSource>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

name

val name: String

ordinal

val ordinal: Int

Functions

valueOf

fun valueOf(value: String): ValueSource

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.)

values

fun values(): Array<ValueSource>

Returns an array containing the constants of this enum type, in the order they're declared.