io.buybrain.util

Class Env

java.lang.Object

io.buybrain.util.Env

public class Env
extends Object

Utility for accessing environment variables

Constructor Summary

Constructors

Constructor and Description
Env() Construct an Env instance with the current system environment

Method Summary

Modifier and Type	Method and Description
int	getInt(String key) Get the value of an environment variable as an integer
int	getInt(String key, int defaultValue) Get the value of an environment variable as an integer, or a default value if it does not exist
String	getString(String key) Get the value of an environment variable as a string
String	getString(String key, String defaultValue) Get the value of an environment variable as a string, or a default value if it does not exist

Methods inherited from class java.lang.Object

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

Constructor Detail

Env

public Env()

Construct an Env instance with the current system environment

Method Detail

getString

public String getString(@NonNull
                        String key)

Get the value of an environment variable as a string

Parameters:

key - the environment variable

Returns:

the string value

Throws:

IllegalArgumentException - if the environment variable does not exist

getString

public String getString(@NonNull
                        String key,
                        String defaultValue)

Get the value of an environment variable as a string, or a default value if it does not exist

Parameters:

key - the environment variable

defaultValue - the value to use if the environment variable does not exist

Returns:

the string value

getInt

public int getInt(@NonNull
                  String key)

Get the value of an environment variable as an integer

Parameters:

key - the environment variable

Returns:

the integer value

Throws:

IllegalArgumentException - if the environment variable does not exist

NumberFormatException - if the value cannot be parsed as an integer

getInt

public int getInt(@NonNull
                  String key,
                  int defaultValue)

Get the value of an environment variable as an integer, or a default value if it does not exist

Parameters:

key - the environment variable

defaultValue - the value to use if the environment variable does not exist

Returns:

the integer value

Throws:

NumberFormatException - if the value cannot be parsed as an integer