com.github.dandelion.core.config

Class Profile

java.lang.Object

com.github.dandelion.core.config.Profile

public class Profile
extends Object

A Profile is typically used to activate a set of configurations which may vary depending on the target environment (e.g. dev, qa, prod).

A Profile is activated using the "dandelion.profile.active" system property and will tell Dandelion to load the configuration file using the following syntax: dandelion_[activeProfile].properties.

Note that only one profile can be activated at a time.

Since:

1.0.0

Author:

Thibault Duchateau

See Also:

StandardConfigurationLoader

Field Summary

Fields

Modifier and Type	Field and Description
static String	DANDELION_PROFILE_ACTIVE
static String	DEFAULT_DEV_PROFILE
static String	DEFAULT_PROD_PROFILE
static String[]	DEV_ALIASES
static String[]	PROD_ALIASES

Constructor Summary

Constructors

Constructor and Description
Profile()

Method Summary

Methods

Modifier and Type	Method and Description
static String	getActiveProfile() Retrieves the current active profile.
static String	getActiveRawProfile() Retrieves the current and untouched active profile.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DANDELION_PROFILE_ACTIVE

public static final String DANDELION_PROFILE_ACTIVE

See Also:

Constant Field Values

DEFAULT_DEV_PROFILE

public static final String DEFAULT_DEV_PROFILE

See Also:

Constant Field Values

DEFAULT_PROD_PROFILE

public static final String DEFAULT_PROD_PROFILE

See Also:

Constant Field Values

DEV_ALIASES

public static final String[] DEV_ALIASES

PROD_ALIASES

public static final String[] PROD_ALIASES

Constructor Detail

Profile

public Profile()

Method Detail

getActiveProfile

public static String getActiveProfile()

Retrieves the current active profile.

Some words are reserved and allow Dandelion to use a preconfigured set of configurations:

• "" (empty or null), "dev" or "development": all these words will lead to activate the "dev" profile, and thus to use all default development values of each DandelionConfig entry.
• "prod" or "production": these words will lead to activate the "prod" profile, and thus to use all default production values of each DandelionConfig entry.

Returns:

• "dev" if the "dandelion.profile.active" system property is set to "", "dev" or "development"
• "prod" if the "dandelion.profile.active" system property is set to "prod" or "production"
• otherwise the active profile, trimmed.

getActiveRawProfile

public static String getActiveRawProfile()

Retrieves the current and untouched active profile.

Returns:

the raw active profile, but at least trimmed if not null and empty.