public final class EnvironmentUtil extends Object
Modifier and Type | Method and Description |
---|---|
static List<Pair<Inet4Address,Integer>> |
addressAndPortListFromEnvironment(String environmentVariableName,
int defaultPort)
Parses an environment variable that contains a list of IPv4 address with
(optional) port numbers.
|
static boolean |
booleanFromEnvironment(String environmentVariableName,
boolean defaultValue)
Parses an environment variable that contains a boolean.
|
static double |
doubleFromEnvironment(String environmentVariableName,
double defaultValue)
Parses an environment variable that contains a double-precision
floating-point number.
|
static int |
integerFromEnvironment(String environmentVariableName,
int defaultValue,
int lowerLimit,
int upperLimit)
Parses an environment variable that contains an integer number.
|
static int |
portNumberFromEnvironment(String environmentVariableName,
int defaultValue,
boolean allowZero)
Parses an environment variable that contains a TCP or UDP port number.
|
public static List<Pair<Inet4Address,Integer>> addressAndPortListFromEnvironment(String environmentVariableName, int defaultPort)
defaultPort
is used.environmentVariableName
- name of the environment variable that shall be parsed.defaultPort
- port number to assume for addresses that do not specify a port
number explicitly.IllegalArgumentException
- if defaultPort
is less than zero or greater than
65535.public static boolean booleanFromEnvironment(String environmentVariableName, boolean defaultValue)
true
and the string "NO" is interpreted as
false
. The comparison is ignoring case. If the value of the
environment variable matches neither string or the environment variable
is not set, defaultValue
is returned.environmentVariableName
- name of the environment variable that shall be parsed.defaultValue
- default value that is used if the environment variable is not
set or its content cannot clearly be mapped to a boolean
value.defaultValue
if value could be determined from the
environment variable.public static int portNumberFromEnvironment(String environmentVariableName, int defaultValue, boolean allowZero)
defaultValue
is returned. If the port number is
zero and allowZero
is false
,
defaultValue
is returned.environmentVariableName
- name of the environment variable that shall be parsed.defaultValue
- default value that is used if the environment variable is not
set or its content is not a valid port number.allowZero
- if true
use the default value if the port number
is zero, if false
allow a zero port number.defaultValue
.public static double doubleFromEnvironment(String environmentVariableName, double defaultValue)
defaultValue
is returned.environmentVariableName
- name of the environment variable that shall be parsed.defaultValue
- default value that is used if the environment variable is not
set or its content is not a valid floating-point number.defaultValue
if the environment variable is not set
or does not contain a valid floating-point number.public static int integerFromEnvironment(String environmentVariableName, int defaultValue, int lowerLimit, int upperLimit)
defaultValue
is returned. If the environment variable
contains an integer number but this number exceeds the specified limits,
it is coerced to the limits.environmentVariableName
- name of the environment variable that shall be parsed.defaultValue
- default value that is used if the environment variable is not
set or its content is not a valid integer number.lowerLimit
- lower limit for the number returned (inclusive). The returned
number is never less than this limit.upperLimit
- upper limit for the number returned (inclusive). The returned
number is never greater than this limit.defaultValue
if the environment variable is not set
or does not contain a valid integer number.IllegalArgumentException
- if the lower limit is greater than the upper limit or if the
default value is not within the interval defined by the lower
and upper limit.Copyright © 2014–2017 aquenos GmbH. All rights reserved.