Package migratedb.v1.core.internal.configuration

Enum Class ConfigUtils

java.lang.Object

java.lang.Enum<ConfigUtils>

migratedb.v1.core.internal.configuration.ConfigUtils

All Implemented Interfaces:

Serializable, Comparable<ConfigUtils>, java.lang.constant.Constable

public enum ConfigUtils
extends Enum<ConfigUtils>

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Method Summary

Modifier and Type	Method	Description
static Map<String,String>	loadConfiguration(Reader reader)	Reads the configuration from a Reader.
static Map<String,String>	propertiesToMap(Properties properties)	Converts properties into a map.
static void	putArrayIfSet(Map<String,String> config, String key, String[]... values)	Puts this property in the config if it has been set in any of these values.
static void	putIfSet(Map<String,String> config, String key, Object... values)	Puts this property in the config if it has been set in any of these values.
static Boolean	removeBoolean(Map<String,String> config, String key)
static Integer	removeInteger(Map<String,String> config, String key)
static void	reportUnrecognisedProperties(Map<String,String> config, String prefix)	Reports all remaining keys in config that start with prefix as unrecognised by throwing an exception.
static ConfigUtils	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ConfigUtils[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Details

values

public static ConfigUtils[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static ConfigUtils valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

loadConfiguration

public static Map<String,String> loadConfiguration(Reader reader)

Reads the configuration from a Reader.

Returns:

The properties from the configuration file. An empty Map if none.

Throws:

MigrateDbException - When the configuration could not be read.

propertiesToMap

public static Map<String,String> propertiesToMap(Properties properties)

Converts properties into a map.

putIfSet

public static void putIfSet(Map<String,String> config,
 String key,
 Object... values)

Puts this property in the config if it has been set in any of these values.

Parameters:

config - The config.

key - The property name.

values - The values to try. The first non-null value will be set.

putArrayIfSet

public static void putArrayIfSet(Map<String,String> config,
 String key,
 String[]... values)

Puts this property in the config if it has been set in any of these values.

Parameters:

config - The config.

key - The property name.

values - The values to try. The first non-null value will be set.

removeBoolean

public static Boolean removeBoolean(Map<String,String> config,
 String key)

Parameters:

config - The config.

key - The property name.

Returns:

The property value as a boolean if it exists, otherwise null.

Throws:

MigrateDbException - when the property value is not a valid boolean.

removeInteger

public static Integer removeInteger(Map<String,String> config,
 String key)

Parameters:

config - The config.

key - The property name.

Returns:

The property value as an integer if it exists, otherwise null.

Throws:

MigrateDbException - When the property value is not a valid integer.

reportUnrecognisedProperties

public static void reportUnrecognisedProperties(Map<String,String> config,
 String prefix)

Reports all remaining keys in config that start with prefix as unrecognised by throwing an exception. Does nothing if config is empty or none of its keys start with prefix.

Parameters:

prefix - The expected prefix for MigrateDB configuration parameters. null if none.