griffon.util

Class ConfigUtils

java.lang.Object

griffon.util.ConfigUtils

public final class ConfigUtils
extends Object

Utility class for reading configuration properties.

Author:

Andres Almiray

Method Summary

Modifier and Type	Method and Description
static Set<String>	collectKeys(Map<String,Object> map)
static boolean	containsKey(Map<String,Object> config, String key) Returns true if there's a non-null value for the specified key.
static boolean	containsKey(ResourceBundle config, String key) Returns true if there's a non-null value for the specified key.
static <T> T	getConfigValue(Map<String,Object> config, String key) Returns the value for the specified key with an optional default value if no match is found.
static <T> T	getConfigValue(Map<String,Object> config, String key, T defaultValue) Returns the value for the specified key with an optional default value if no match is found.
static <T> T	getConfigValue(ResourceBundle config, String key) Returns the value for the specified key with an optional default value if no match is found.
static <T> T	getConfigValue(ResourceBundle config, String key, T defaultValue) Returns the value for the specified key with an optional default value if no match is found.
static boolean	getConfigValueAsBoolean(Map<String,Object> config, String key) Returns the value for the specified key coerced to a boolean.
static boolean	getConfigValueAsBoolean(Map<String,Object> config, String key, boolean defaultValue) Returns the value for the specified key with an optional default value if no match is found.
static double	getConfigValueAsDouble(Map<String,Object> config, String key) Returns the value for the specified key coerced to a double.
static double	getConfigValueAsDouble(Map<String,Object> config, String key, double defaultValue) Returns the value for the specified key with an optional default value if no match is found.
static float	getConfigValueAsFloat(Map<String,Object> config, String key) Returns the value for the specified key coerced to a float.
static float	getConfigValueAsFloat(Map<String,Object> config, String key, float defaultValue) Returns the value for the specified key with an optional default value if no match is found.
static int	getConfigValueAsInt(Map<String,Object> config, String key) Returns the value for the specified key coerced to an int.
static int	getConfigValueAsInt(Map<String,Object> config, String key, int defaultValue) Returns the value for the specified key with an optional default value if no match is found.
static long	getConfigValueAsLong(Map<String,Object> config, String key) Returns the value for the specified key coerced to a long.
static long	getConfigValueAsLong(Map<String,Object> config, String key, long defaultValue) Returns the value for the specified key with an optional default value if no match is found.
static Number	getConfigValueAsNumber(Map<String,Object> config, String key) Returns the value for the specified key coerced to a Number.
static Number	getConfigValueAsNumber(Map<String,Object> config, String key, Number defaultValue) Returns the value for the specified key with an optional default value if no match is found.
static String	getConfigValueAsString(Map<String,Object> config, String key) Returns the value for the specified key converted to a String.
static String	getConfigValueAsString(Map<String,Object> config, String key, String defaultValue) Returns the value for the specified key with an optional default value if no match is found.
static String	getFilenameExtension(String path) Extract the filename extension from the given path, e.g.
static boolean	isValueDefined(Map<String,Object> config, String key) Returns true if there's a non-null value for the specified key.
static boolean	isValueDefined(ResourceBundle config, String key) Returns true if there's a non-null value for the specified key.
static String	stripFilenameExtension(String path) Strip the filename extension from the given path, e.g.
static Properties	toProperties(ResourceBundle resourceBundle) Converts a ResourceBundle instance into a Properties instance.

Methods inherited from class java.lang.Object

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

Method Detail

toProperties

@Nonnull
public static Properties toProperties(@Nonnull
                                               ResourceBundle resourceBundle)

Converts a ResourceBundle instance into a Properties instance.

Parameters:

resourceBundle - the ResourceBundle to be converted. Must not be null.

Returns:

a newly created Properties with all key/value pairs from the given ResourceBundle.

Since:

2.10.0

containsKey

public static boolean containsKey(@Nonnull
                                  Map<String,Object> config,
                                  @Nonnull
                                  String key)

Returns true if there's a non-null value for the specified key.

Parameters:

config - the configuration object to be searched upon

key - the key to be searched

Returns:

true if there's a value for the specified key, false otherwise

Since:

2.2.0

containsKey

public static boolean containsKey(@Nonnull
                                  ResourceBundle config,
                                  @Nonnull
                                  String key)

Returns true if there's a non-null value for the specified key.

Parameters:

config - the configuration object to be searched upon

key - the key to be searched

Returns:

true if there's a value for the specified key, false otherwise

Since:

2.2.0

isValueDefined

public static boolean isValueDefined(@Nonnull
                                     Map<String,Object> config,
                                     @Nonnull
                                     String key)

Returns true if there's a non-null value for the specified key.

Parameters:

config - the configuration object to be searched upon

key - the key to be searched

Returns:

true if there's a value for the specified key, false otherwise

isValueDefined

public static boolean isValueDefined(@Nonnull
                                     ResourceBundle config,
                                     @Nonnull
                                     String key)

Returns true if there's a non-null value for the specified key.

Parameters:

config - the configuration object to be searched upon

key - the key to be searched

Returns:

true if there's a value for the specified key, false otherwise

getConfigValue

@Nullable
public static <T> T getConfigValue(@Nonnull
                                             Map<String,Object> config,
                                             @Nonnull
                                             String key,
                                             @Nullable
                                             T defaultValue)

Returns the value for the specified key with an optional default value if no match is found.

Parameters:

config - the configuration object to be searched upon

key - the key to be searched

defaultValue - the value to send back if no match is found

Returns:

the value of the key or the default value if no match is found

getConfigValue

@Nullable
public static <T> T getConfigValue(@Nonnull
                                             ResourceBundle config,
                                             @Nonnull
                                             String key,
                                             @Nullable
                                             T defaultValue)

Returns the value for the specified key with an optional default value if no match is found.

Parameters:

config - the configuration object to be searched upon

key - the key to be searched

defaultValue - the value to send back if no match is found

Returns:

the value of the key or the default value if no match is found

getConfigValue

@Nullable
public static <T> T getConfigValue(@Nonnull
                                             Map<String,Object> config,
                                             @Nonnull
                                             String key)
                                      throws MissingResourceException

Returns the value for the specified key with an optional default value if no match is found.

Parameters:

config - the configuration object to be searched upon

key - the key to be searched

Returns:

the value of the key or the default value if no match is found

Throws:

MissingResourceException

getConfigValue

@Nullable
public static <T> T getConfigValue(@Nonnull
                                             ResourceBundle config,
                                             @Nonnull
                                             String key)
                                      throws MissingResourceException

Returns the value for the specified key with an optional default value if no match is found.

Parameters:

config - the configuration object to be searched upon

key - the key to be searched

Returns:

the value of the key or the default value if no match is found

Throws:

MissingResourceException

getConfigValueAsBoolean

public static boolean getConfigValueAsBoolean(@Nonnull
                                              Map<String,Object> config,
                                              @Nonnull
                                              String key)

Returns the value for the specified key coerced to a boolean.

Parameters:

config - the configuration object to be searched upon

key - the key to be searched

Returns:

the value of the key. Returns false if no match.

getConfigValueAsBoolean

public static boolean getConfigValueAsBoolean(@Nonnull
                                              Map<String,Object> config,
                                              @Nonnull
                                              String key,
                                              boolean defaultValue)

Returns the value for the specified key with an optional default value if no match is found.

Parameters:

config - the configuration object to be searched upon

key - the key to be searched

defaultValue - the value to send back if no match is found

Returns:

the value of the key or the default value if no match is found

getConfigValueAsInt

public static int getConfigValueAsInt(@Nonnull
                                      Map<String,Object> config,
                                      @Nonnull
                                      String key)

Returns the value for the specified key coerced to an int.

Parameters:

config - the configuration object to be searched upon

key - the key to be searched

Returns:

the value of the key. Returns 0 if no match.

getConfigValueAsInt

public static int getConfigValueAsInt(@Nonnull
                                      Map<String,Object> config,
                                      @Nonnull
                                      String key,
                                      int defaultValue)

Returns the value for the specified key with an optional default value if no match is found.

Parameters:

config - the configuration object to be searched upon

key - the key to be searched

defaultValue - the value to send back if no match is found

Returns:

the value of the key or the default value if no match is found

getConfigValueAsLong

public static long getConfigValueAsLong(@Nonnull
                                        Map<String,Object> config,
                                        @Nonnull
                                        String key)

Returns the value for the specified key coerced to a long.

Parameters:

config - the configuration object to be searched upon

key - the key to be searched

Returns:

the value of the key. Returns 0L if no match.

getConfigValueAsLong

public static long getConfigValueAsLong(@Nonnull
                                        Map<String,Object> config,
                                        @Nonnull
                                        String key,
                                        long defaultValue)

Returns the value for the specified key with an optional default value if no match is found.

Parameters:

config - the configuration object to be searched upon

key - the key to be searched

defaultValue - the value to send back if no match is found

Returns:

the value of the key or the default value if no match is found

getConfigValueAsDouble

public static double getConfigValueAsDouble(@Nonnull
                                            Map<String,Object> config,
                                            @Nonnull
                                            String key)

Returns the value for the specified key coerced to a double.

Parameters:

config - the configuration object to be searched upon

key - the key to be searched

Returns:

the value of the key. Returns 0d if no match.

getConfigValueAsDouble

public static double getConfigValueAsDouble(@Nonnull
                                            Map<String,Object> config,
                                            @Nonnull
                                            String key,
                                            double defaultValue)

Returns the value for the specified key with an optional default value if no match is found.

Parameters:

config - the configuration object to be searched upon

key - the key to be searched

defaultValue - the value to send back if no match is found

Returns:

the value of the key or the default value if no match is found

getConfigValueAsFloat

public static float getConfigValueAsFloat(@Nonnull
                                          Map<String,Object> config,
                                          @Nonnull
                                          String key)

Returns the value for the specified key coerced to a float.

Parameters:

config - the configuration object to be searched upon

key - the key to be searched

Returns:

the value of the key. Returns 0f if no match.

getConfigValueAsFloat

public static float getConfigValueAsFloat(@Nonnull
                                          Map<String,Object> config,
                                          @Nonnull
                                          String key,
                                          float defaultValue)

Returns the value for the specified key with an optional default value if no match is found.

Parameters:

config - the configuration object to be searched upon

key - the key to be searched

defaultValue - the value to send back if no match is found

Returns:

the value of the key or the default value if no match is found

getConfigValueAsNumber

@Nullable
public static Number getConfigValueAsNumber(@Nonnull
                                                      Map<String,Object> config,
                                                      @Nonnull
                                                      String key)

Returns the value for the specified key coerced to a Number.

Parameters:

config - the configuration object to be searched upon

key - the key to be searched

Returns:

the value of the key. Returns null if no match.

getConfigValueAsNumber

@Nullable
public static Number getConfigValueAsNumber(@Nonnull
                                                      Map<String,Object> config,
                                                      @Nonnull
                                                      String key,
                                                      @Nullable
                                                      Number defaultValue)

Returns the value for the specified key with an optional default value if no match is found.

Parameters:

config - the configuration object to be searched upon

key - the key to be searched

defaultValue - the value to send back if no match is found

Returns:

the value of the key or the default value if no match is found

getConfigValueAsString

@Nullable
public static String getConfigValueAsString(@Nonnull
                                                      Map<String,Object> config,
                                                      @Nonnull
                                                      String key)

Returns the value for the specified key converted to a String.

Parameters:

config - the configuration object to be searched upon

key - the key to be searched

Returns:

the value of the key. Returns "" if no match.

getConfigValueAsString

@Nullable
public static String getConfigValueAsString(@Nonnull
                                                      Map<String,Object> config,
                                                      @Nonnull
                                                      String key,
                                                      @Nullable
                                                      String defaultValue)

Returns the value for the specified key with an optional default value if no match is found.

Parameters:

config - the configuration object to be searched upon

key - the key to be searched

defaultValue - the value to send back if no match is found

Returns:

the value of the key or the default value if no match is found

getFilenameExtension

public static String getFilenameExtension(String path)

Extract the filename extension from the given path, e.g. "mypath/myfile.txt" -> "txt".

Parameters:

path - the file path (may be null)

Returns:

the extracted filename extension, or null if none

stripFilenameExtension

public static String stripFilenameExtension(String path)

Strip the filename extension from the given path, e.g. "mypath/myfile.txt" -> "mypath/myfile".

Parameters:

path - the file path (may be null)

Returns:

the path with stripped filename extension, or null if none

collectKeys

@Nonnull
public static Set<String> collectKeys(@Nonnull
                                               Map<String,Object> map)