public final class EnvironmentUtil
extends java.lang.Object
Modifier and Type | Method and Description |
---|---|
static java.util.List<org.apache.commons.lang3.tuple.Pair<java.net.Inet4Address,java.lang.Integer>> |
addressAndPortListFromEnvironment(java.lang.String environmentVariableName,
int defaultPort)
Deprecated.
since EPICS Jackie 3.1.0. Consider using
inet4SocketAddressListFromEnvironment(String, int, boolean, ErrorHandler)
instead. |
static boolean |
booleanFromEnvironment(java.lang.String environmentVariableName,
boolean defaultValue)
Parses an environment variable that contains a boolean.
|
static double |
doubleFromEnvironment(java.lang.String environmentVariableName,
double defaultValue)
Deprecated.
since EPICS Jackie 3.1.0.
|
static double |
doubleFromEnvironment(java.lang.String environmentVariableName,
double defaultValue,
ErrorHandler errorHandler)
Parses an environment variable that contains a double-precision
floating-point number.
|
static java.util.List<java.net.InetSocketAddress> |
inet4SocketAddressListFromEnvironment(java.lang.String environmentVariableName,
int defaultPort,
boolean allowZero,
ErrorHandler errorHandler)
Parses an environment variable that contains a whitespace-separated list
of host-port pairs.
|
static int |
integerFromEnvironment(java.lang.String environmentVariableName,
int defaultValue,
int lowerLimit,
int upperLimit)
Deprecated.
since EPICS Jackie 3.1.0.
|
static int |
integerFromEnvironment(java.lang.String environmentVariableName,
int defaultValue,
int lowerLimit,
int upperLimit,
ErrorHandler errorHandler)
Parses an environment variable that contains an integer number.
|
static int |
portNumberFromEnvironment(java.lang.String environmentVariableName,
int defaultValue,
boolean allowZero)
Deprecated.
since EPICS Jackie 3.1.0.
|
static int |
portNumberFromEnvironment(java.lang.String environmentVariableName,
int defaultValue,
boolean allowZero,
ErrorHandler errorHandler)
Parses an environment variable that contains a TCP or UDP port number.
|
@Deprecated public static java.util.List<org.apache.commons.lang3.tuple.Pair<java.net.Inet4Address,java.lang.Integer>> addressAndPortListFromEnvironment(java.lang.String environmentVariableName, int defaultPort)
inet4SocketAddressListFromEnvironment(String, int, boolean, ErrorHandler)
instead.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.java.lang.IllegalArgumentException
- if defaultPort
is less than zero or greater than
65535.public static boolean booleanFromEnvironment(java.lang.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 nor 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.@Deprecated public static int portNumberFromEnvironment(java.lang.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 int portNumberFromEnvironment(java.lang.String environmentVariableName, int defaultValue, boolean allowZero, ErrorHandler errorHandler)
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.errorHandler
- error handler which is notified when there is a problem with
the value of the environment variable. If null
,
such problems are corrected silently.defaultValue
.@Deprecated public static double doubleFromEnvironment(java.lang.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 double doubleFromEnvironment(java.lang.String environmentVariableName, double defaultValue, ErrorHandler errorHandler)
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.errorHandler
- error handler which is notified when there is a problem with
the value of the environment variable. If null
,
such problems are corrected silently.defaultValue
if the environment variable is not set
or does not contain a valid, finite floating-point number.public static java.util.List<java.net.InetSocketAddress> inet4SocketAddressListFromEnvironment(java.lang.String environmentVariableName, int defaultPort, boolean allowZero, ErrorHandler errorHandler)
Parses an environment variable that contains a whitespace-separated list
of host-port pairs. If an entry specified a port number, it must be
separated from the host part by a colon (e.g.
host.example.com:12345
, 127.0.0.1:4567
).
Only IPv4 addresses are supported by this function. If a hostname
resolves to both IPv4 and IPv6 addresses, the IPv6 addresses are silently
ignored. If it only resolves to IPv6 addresses, an error message is
logged using the provided errorHandler
.
environmentVariableName
- name of the environment variable from which the value is
retrieved.defaultPort
- port number that is used for entries that do not explicitly
specify a port number.allowZero
- controls whether a port number of zero is allowed or not.errorHandler
- error handler that is called when an invalid token is
encountered (e.g. a token with an invalid port number or a
hostname that cannot be resolved). If null
, such
errors are silently ignored.java.lang.IllegalArgumentException
- if defaultPort
does not represent a valid port number.Inet4AddressUtil.stringToInet4SocketAddressList(String, int, boolean, ErrorHandler)
@Deprecated public static int integerFromEnvironment(java.lang.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.java.lang.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.public static int integerFromEnvironment(java.lang.String environmentVariableName, int defaultValue, int lowerLimit, int upperLimit, ErrorHandler errorHandler)
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.java.lang.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–2024 aquenos GmbH. All rights reserved.