Package org.yamcs

Enum Class ConfigScope

java.lang.Object

java.lang.Enum<ConfigScope>

org.yamcs.ConfigScope

All Implemented Interfaces:

Serializable, Comparable<ConfigScope>, Constable

public enum ConfigScope
extends Enum<ConfigScope>

Represents a type of configuration file

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
YAMCS	Represents yamcs.yaml configuration.
YAMCS_INSTANCE	Represents yamcs.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

YAMCS

public static final ConfigScope YAMCS

Represents yamcs.yaml configuration. This file contains global configuration options.

YAMCS_INSTANCE

public static final ConfigScope YAMCS_INSTANCE

Represents yamcs.[instance].yaml configuration. Such files contain instance-specific configuration options.

Method Details

values

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