Package com.helger.config.source.envvar

Class EnvVarHelper

java.lang.Object

com.helger.config.source.envvar.EnvVarHelper

@Immutable
public final class EnvVarHelper
extends Object

Helper functions for environment variables

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field	Description
static final char	DEFAULT_REPLACEMENT_CHAR
static final char	REPLACEMENT_CHAR_TO_SKIP

Method Summary

Modifier and Type	Method	Description
static String	getUnifiedSysEnvName(String sName, char cReplacement)	Get a unified system environment variable name from the provided property name.
static boolean	isValidFirstChar(char c)	Check if the provided character is a valid first character for an environment variable.
static boolean	isValidFollowingChar(char c)	Check if the provided character is a valid second or following character for an environment variable.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_REPLACEMENT_CHAR

public static final char DEFAULT_REPLACEMENT_CHAR

See Also:

• Constant Field Values

REPLACEMENT_CHAR_TO_SKIP

public static final char REPLACEMENT_CHAR_TO_SKIP

See Also:

• Constant Field Values

Method Details

isValidFirstChar

public static boolean isValidFirstChar(char c)

Check if the provided character is a valid first character for an environment variable.

Parameters:

c - The character to check

Returns:

true if it is valid, false if not

isValidFollowingChar

public static boolean isValidFollowingChar(char c)

Check if the provided character is a valid second or following character for an environment variable.

Parameters:

c - The character to check

Returns:

true if it is valid, false if not

getUnifiedSysEnvName

@Nonnull
public static String getUnifiedSysEnvName(@Nonnull @Nonempty
 String sName,
 char cReplacement)

Get a unified system environment variable name from the provided property name. This means uppercasing all characters and replacing invalid chars with a replacement character.

Parameters:

sName - The property name to convert. May neither be null nor empty.

cReplacement - The character that should be used to replace invalid characters. See DEFAULT_REPLACEMENT_CHAR. If character `´ is used, the invalid character is simply ignored. See REPLACEMENT_CHAR_TO_SKIP.

Returns:

The