Package io.micronaut.core.value

Enum Class PropertyCatalog

java.lang.Object

java.lang.Enum<PropertyCatalog>

io.micronaut.core.value.PropertyCatalog

All Implemented Interfaces:

Serializable, Comparable<PropertyCatalog>, Constable

public enum PropertyCatalog
extends Enum<PropertyCatalog>

The property catalog to use.

Since:

4.7.0

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
GENERATED	The catalog that contains normalized keys and also generated keys.
NORMALIZED	The catalog that contains normalized keys.
RAW	The catalog that contains the raw keys.

Method Summary

Modifier and Type	Method	Description
static PropertyCatalog	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PropertyCatalog[]	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

RAW

public static final PropertyCatalog RAW

The catalog that contains the raw keys.

NORMALIZED

public static final PropertyCatalog NORMALIZED

The catalog that contains normalized keys. A key is normalized into lower case hyphen separated form. For example an environment variable FOO_BAR would be normalized to foo.bar.

GENERATED

public static final PropertyCatalog GENERATED

The catalog that contains normalized keys and also generated keys. A synthetic key can be generated from an environment variable such as FOO_BAR_BAZ which will produce the following keys: foo.bar.baz, foo.bar-baz, and foo-bar.baz.

Method Details

values

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