Package org.eclipse.aether.util
Class ConfigUtils
java.lang.Object
org.eclipse.aether.util.ConfigUtils
A utility class to read configuration properties from a repository system session.
-
Method Summary
Modifier and TypeMethodDescriptionstatic boolean
getBoolean
(Map<?, ?> properties, boolean defaultValue, String... keys) Gets the specified configuration property.static boolean
getBoolean
(RepositorySystemSession session, boolean defaultValue, String... keys) Gets the specified configuration property.static float
Gets the specified configuration property.static float
getFloat
(RepositorySystemSession session, float defaultValue, String... keys) Gets the specified configuration property.static int
getInteger
(Map<?, ?> properties, int defaultValue, String... keys) Gets the specified configuration property.static int
getInteger
(RepositorySystemSession session, int defaultValue, String... keys) Gets the specified configuration property.static List<?>
Gets the specified configuration property.static List<?>
getList
(RepositorySystemSession session, List<?> defaultValue, String... keys) Gets the specified configuration property.static long
Gets the specified configuration property.static long
getLong
(RepositorySystemSession session, long defaultValue, String... keys) Gets the specified configuration property.static Map<?,
?> Gets the specified configuration property.static Map<?,
?> getMap
(RepositorySystemSession session, Map<?, ?> defaultValue, String... keys) Gets the specified configuration property.static Object
Gets the specified configuration property.static Object
getObject
(RepositorySystemSession session, Object defaultValue, String... keys) Gets the specified configuration property.static String
Gets the specified configuration property.static String
getString
(RepositorySystemSession session, String defaultValue, String... keys) Gets the specified configuration property.parseCommaSeparatedNames
(String commaSeparatedNames) Utility method to parse configuration string that contains comma separated list of names intoList<String>
, never returnsnull
.parseCommaSeparatedUniqueNames
(String commaSeparatedNames) Utility method to parse configuration string that contains comma separated list of names intoList<String>
with unique elements (duplicates, if any, are discarded), never returnsnull
.
-
Method Details
-
getObject
Gets the specified configuration property.- Parameters:
properties
- The configuration properties to read, must not benull
.defaultValue
- The default value to return in case none of the property keys are set, may benull
.keys
- The property keys to read, must not benull
. The specified keys are read one after one until a valid value is found.- Returns:
- The property value or
null
if none.
-
getObject
public static Object getObject(RepositorySystemSession session, Object defaultValue, String... keys) Gets the specified configuration property.- Parameters:
session
- The repository system session from which to read the configuration property, must not benull
.defaultValue
- The default value to return in case none of the property keys are set, may benull
.keys
- The property keys to read, must not benull
. The specified keys are read one after one until a valid value is found.- Returns:
- The property value or
null
if none.
-
getString
Gets the specified configuration property.- Parameters:
properties
- The configuration properties to read, must not benull
.defaultValue
- The default value to return in case none of the property keys is set to a string, may benull
.keys
- The property keys to read, must not benull
. The specified keys are read one after one until a string value is found.- Returns:
- The property value or
null
if none.
-
getString
public static String getString(RepositorySystemSession session, String defaultValue, String... keys) Gets the specified configuration property.- Parameters:
session
- The repository system session from which to read the configuration property, must not benull
.defaultValue
- The default value to return in case none of the property keys is set to a string, may benull
.keys
- The property keys to read, must not benull
. The specified keys are read one after one until a string value is found.- Returns:
- The property value or
null
if none.
-
getInteger
Gets the specified configuration property.- Parameters:
properties
- The configuration properties to read, must not benull
.defaultValue
- The default value to return in case none of the property keys is set to a number.keys
- The property keys to read, must not benull
. The specified keys are read one after one until aNumber
or a string representation of anInteger
is found.- Returns:
- The property value.
-
getInteger
Gets the specified configuration property.- Parameters:
session
- The repository system session from which to read the configuration property, must not benull
.defaultValue
- The default value to return in case none of the property keys is set to a number.keys
- The property keys to read, must not benull
. The specified keys are read one after one until aNumber
or a string representation of anInteger
is found.- Returns:
- The property value.
-
getLong
Gets the specified configuration property.- Parameters:
properties
- The configuration properties to read, must not benull
.defaultValue
- The default value to return in case none of the property keys is set to a number.keys
- The property keys to read, must not benull
. The specified keys are read one after one until aNumber
or a string representation of aLong
is found.- Returns:
- The property value.
-
getLong
Gets the specified configuration property.- Parameters:
session
- The repository system session from which to read the configuration property, must not benull
.defaultValue
- The default value to return in case none of the property keys is set to a number.keys
- The property keys to read, must not benull
. The specified keys are read one after one until aNumber
or a string representation of aLong
is found.- Returns:
- The property value.
-
getFloat
Gets the specified configuration property.- Parameters:
properties
- The configuration properties to read, must not benull
.defaultValue
- The default value to return in case none of the property keys is set to a number.keys
- The property keys to read, must not benull
. The specified keys are read one after one until aNumber
or a string representation of aFloat
is found.- Returns:
- The property value.
-
getFloat
Gets the specified configuration property.- Parameters:
session
- The repository system session from which to read the configuration property, must not benull
.defaultValue
- The default value to return in case none of the property keys is set to a number.keys
- The property keys to read, must not benull
. The specified keys are read one after one until aNumber
or a string representation of aFloat
is found.- Returns:
- The property value.
-
getBoolean
Gets the specified configuration property.- Parameters:
properties
- The configuration properties to read, must not benull
.defaultValue
- The default value to return in case none of the property keys is set to a boolean.keys
- The property keys to read, must not benull
. The specified keys are read one after one until aBoolean
or a string (to beparsed as boolean
) is found.- Returns:
- The property value.
-
getBoolean
public static boolean getBoolean(RepositorySystemSession session, boolean defaultValue, String... keys) Gets the specified configuration property.- Parameters:
session
- The repository system session from which to read the configuration property, must not benull
.defaultValue
- The default value to return in case none of the property keys is set to a boolean.keys
- The property keys to read, must not benull
. The specified keys are read one after one until aBoolean
or a string (to beparsed as boolean
) is found.- Returns:
- The property value.
-
getList
Gets the specified configuration property.- Parameters:
properties
- The configuration properties to read, must not benull
.defaultValue
- The default value to return in case none of the property keys is set to a collection.keys
- The property keys to read, must not benull
. The specified keys are read one after one until a collection is found.- Returns:
- The property value or
null
if none.
-
getList
public static List<?> getList(RepositorySystemSession session, List<?> defaultValue, String... keys) Gets the specified configuration property.- Parameters:
session
- The repository system session from which to read the configuration property, must not benull
.defaultValue
- The default value to return in case none of the property keys is set to a collection.keys
- The property keys to read, must not benull
. The specified keys are read one after one until a collection is found.- Returns:
- The property value or
null
if none.
-
getMap
Gets the specified configuration property.- Parameters:
properties
- The configuration properties to read, must not benull
.defaultValue
- The default value to return in case none of the property keys is set to a map.keys
- The property keys to read, must not benull
. The specified keys are read one after one until a map is found.- Returns:
- The property value or
null
if none.
-
getMap
public static Map<?,?> getMap(RepositorySystemSession session, Map<?, ?> defaultValue, String... keys) Gets the specified configuration property.- Parameters:
session
- The repository system session from which to read the configuration property, must not benull
.defaultValue
- The default value to return in case none of the property keys is set to a map.keys
- The property keys to read, must not benull
. The specified keys are read one after one until a map is found.- Returns:
- The property value or
null
if none.
-
parseCommaSeparatedNames
Utility method to parse configuration string that contains comma separated list of names intoList<String>
, never returnsnull
.- Since:
- 1.9.0
-
parseCommaSeparatedUniqueNames
Utility method to parse configuration string that contains comma separated list of names intoList<String>
with unique elements (duplicates, if any, are discarded), never returnsnull
.- Since:
- 1.9.0
-