com.cloudera.oryx.common.settings

Class ConfigUtils

java.lang.Object

com.cloudera.oryx.common.settings.ConfigUtils

public final class ConfigUtils
extends Object

Utilities for retrieving Config instances.

Method Summary

Modifier and Type	Method and Description
static com.typesafe.config.Config	deserialize(String serialized)
static com.typesafe.config.Config	getDefault() Returns the default Config object for this app, based on config in the JAR file or otherwise specified to the library.
static Double	getOptionalDouble(com.typesafe.config.Config config, String key)
static String	getOptionalString(com.typesafe.config.Config config, String key)
static List<String>	getOptionalStringList(com.typesafe.config.Config config, String key)
static Properties	keyValueToProperties(Object... keyValues)
static com.typesafe.config.Config	overlayOn(Map<String,?> overlay, com.typesafe.config.Config underlying)
static String	prettyPrint(com.typesafe.config.Config config)
static String	serialize(com.typesafe.config.Config config)
static void	set(Map<String,Object> overlay, String key, Path path) Helper to set a Path value correctly for use with overlayOn(Map,Config).

Methods inherited from class java.lang.Object

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

Method Detail

getDefault

public static com.typesafe.config.Config getDefault()

Returns the default Config object for this app, based on config in the JAR file or otherwise specified to the library.

Returns:

default configuration

overlayOn

public static com.typesafe.config.Config overlayOn(Map<String,?> overlay,
                                                   com.typesafe.config.Config underlying)

Parameters:

overlay - map of key-value pairs to add to default config. The map is converted to a string representation, as it were from a config file, and parsed accordingly.

underlying - underlying config to overlay new settings on top of

Returns:

default config but with key-value pairs added

getOptionalString

public static String getOptionalString(com.typesafe.config.Config config,
                                       String key)

Parameters:

config - configuration to query for value

key - configuration path key

Returns:

value for given key, or null if none exists

getOptionalStringList

public static List<String> getOptionalStringList(com.typesafe.config.Config config,
                                                 String key)

Parameters:

config - configuration to query for value

key - configuration path key

Returns:

value for given key, or null if none exists

getOptionalDouble

public static Double getOptionalDouble(com.typesafe.config.Config config,
                                       String key)

Parameters:

config - configuration to query for value

key - configuration path key

Returns:

value for given key, or null if none exists

set

public static void set(Map<String,Object> overlay,
                       String key,
                       Path path)
                throws IOException

Helper to set a Path value correctly for use with overlayOn(Map,Config).

Parameters:

overlay - key-value pairs to overlay on a Config

key - key to set

path - Path value

Throws:

IOException - if Path can't be made canonical

serialize

public static String serialize(com.typesafe.config.Config config)

Parameters:

config - Config to serialize to a String

Returns:

JSON-like representation of properties in the configuration, excluding those inherited from the local JVM environment

deserialize

public static com.typesafe.config.Config deserialize(String serialized)

Parameters:

serialized - serialized form of configuration as JSON-like data

Returns:

Config from the serialized config

prettyPrint

public static String prettyPrint(com.typesafe.config.Config config)

Parameters:

config - Config to print

Returns:

pretty-printed version of config values, excluding those inherited from the local JVM environment

keyValueToProperties

public static Properties keyValueToProperties(Object... keyValues)

Parameters:

keyValues - a sequence key1, value1, key2, value2, ... where the Object.toString() of successive pairs are interpreted as key-value pairs

Returns:

a Properties containing these key-value pairs