com.cloudera.director.aws.common

Class HoconConfigUtils

java.lang.Object

com.cloudera.director.aws.common.HoconConfigUtils

public final class HoconConfigUtils
extends Object

Provides utilities for dealing with typesafe config.

Method Summary

Modifier and Type	Method and Description
static String	asConfigKey(String path) Returns a string that will be interpreted by the typesafe config library as a single key instead of as a path through nested configurations.
static String	asConfigPath(String key) Returns a string that will be interpreted by the typesafe config library as a path through nested configurations, instead of as a single key.
static com.typesafe.config.Config	getSectionConfiguration(com.typesafe.config.Config config, com.google.common.base.Optional<String> sectionKey) Returns the specified optional configuration subsection.
static com.typesafe.config.Config	getSectionConfiguration(com.typesafe.config.Config config, String sectionKey) Returns the specified configuration subsection.
static Map<String,String>	getStringMap(com.typesafe.config.Config config, String key) Returns a map view of the data associated with the specified key.
static String	stripQuotes(String key) Returns a key that has any matched pair of double quotes present at the beginning and end of the key removed.

Methods inherited from class java.lang.Object

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

Method Detail

asConfigKey

public static String asConfigKey(String path)

Returns a string that will be interpreted by the typesafe config library as a single key instead of as a path through nested configurations.

Parameters:

path - the path, which may contain periods

Returns:

the configuration key, will be interpreted by the typesafe config library as a single unit instead of as a path through nested configurations

asConfigPath

public static String asConfigPath(String key)

Returns a string that will be interpreted by the typesafe config library as a path through nested configurations, instead of as a single key.

Parameters:

key - the key

Returns:

the configuration path, will be interpreted by the typesafe config library as a path through nested configurations, instead of as a single unit

stripQuotes

public static String stripQuotes(String key)

Returns a key that has any matched pair of double quotes present at the beginning and end of the key removed.

Parameters:

key - the key

Returns:

the key without beginning and trailing quotes (if present)

getStringMap

public static Map<String,String> getStringMap(com.typesafe.config.Config config,
                                              String key)

Returns a map view of the data associated with the specified key. If the key corresponds to a string list, each element of the list will be mapped to itself. If the key corresponds to a nested configuration, the map will contain those entries of the nested configuration which have string values (but not, for example, further nested configurations). If the key corresponds to some other type, throws an exception from the underlying typesafe config implementation.

Parameters:

config - the configuration

key - the key

Returns:

a map view of the data associated with the specified key

getSectionConfiguration

public static com.typesafe.config.Config getSectionConfiguration(com.typesafe.config.Config config,
                                                                 com.google.common.base.Optional<String> sectionKey)

Returns the specified optional configuration subsection.

Parameters:

config - the optional configuration

sectionKey - the optional desired configuration subsection

Returns:

the specified optional configuration subsection

getSectionConfiguration

public static com.typesafe.config.Config getSectionConfiguration(com.typesafe.config.Config config,
                                                                 String sectionKey)

Returns the specified configuration subsection.

Parameters:

config - the configuration

sectionKey - the desired configuration subsection

Returns:

the specified configuration subsection