com.linkedin.feathr.common.configObj.configbuilder

Class ConfigUtils

java.lang.Object

com.linkedin.feathr.common.configObj.configbuilder.ConfigUtils

public class ConfigUtils
extends java.lang.Object

Utils to read typesafe configs

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TIMESTAMP_FORMAT_EPOCH
static java.lang.String	TIMESTAMP_FORMAT_EPOCH_MILLIS

Method Summary

Modifier and Type	Method and Description
static boolean	getBooleanWithDefault(com.typesafe.config.Config config, java.lang.String path, java.lang.Boolean defaultValue) return boolean config value with default
static java.time.temporal.ChronoUnit	getChronoUnit(java.lang.String timeResolutionStr) convert ChronoUnit String to ChronoUnit enum
static java.time.Duration	getDurationWithDefault(com.typesafe.config.Config config, java.lang.String path, java.time.Duration defaultValue) return numeric config value with default
static java.lang.String	getHoconString(com.typesafe.config.Config config, java.lang.String path) Get the typesafe ConfigValue.render() with given path
static int	getIntWithDefault(com.typesafe.config.Config config, java.lang.String path, int defaultValue) return int config value with default
static long	getLongWithDefault(com.typesafe.config.Config config, java.lang.String path, long defaultValue) return long config value with default
static java.lang.Number	getNumberWithDefault(com.typesafe.config.Config config, java.lang.String path, java.lang.Number defaultValue) return numeric config value with default
static java.util.List<java.lang.String>	getStringList(com.typesafe.config.Config config, java.lang.String path) return a String list config value where the value can be either a single String or String list
static java.util.Map<java.lang.String,java.lang.String>	getStringMap(com.typesafe.config.Config config) return a String map config value where the key and value are both simple String
static java.lang.String	getStringWithDefault(com.typesafe.config.Config config, java.lang.String path, java.lang.String defaultValue) return string config value with default
static void	validateTimestampPattern(java.lang.String fieldName, java.lang.String fieldValue, java.lang.String timestampPattern) Check if the input timestamp pattern is valid by invoking the DateTimeFormatter.
static void	validateTimestampPatternWithEpoch(java.lang.String fieldName, java.lang.String fieldValue, java.lang.String timestampPattern) Check if the input timestamp pattern is valid by checking for epoch/epoch_millis and then invoking the DateTimeFormatter.

Methods inherited from class java.lang.Object

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

Field Detail

TIMESTAMP_FORMAT_EPOCH

public static final java.lang.String TIMESTAMP_FORMAT_EPOCH

See Also:

Constant Field Values

TIMESTAMP_FORMAT_EPOCH_MILLIS

public static final java.lang.String TIMESTAMP_FORMAT_EPOCH_MILLIS

See Also:

Constant Field Values

Method Detail

getStringWithDefault

public static java.lang.String getStringWithDefault(com.typesafe.config.Config config,
                                                    java.lang.String path,
                                                    java.lang.String defaultValue)

return string config value with default

Parameters:

config - typesafe config to read value from

path - path of the config value

Returns:

config value

getIntWithDefault

public static int getIntWithDefault(com.typesafe.config.Config config,
                                    java.lang.String path,
                                    int defaultValue)

return int config value with default

Parameters:

config - typesafe config to read value from

path - path of the config value

Returns:

config value

getNumberWithDefault

public static java.lang.Number getNumberWithDefault(com.typesafe.config.Config config,
                                                    java.lang.String path,
                                                    java.lang.Number defaultValue)

return numeric config value with default

Parameters:

config - typesafe config to read value from

path - path of the config value

Returns:

config value

getDurationWithDefault

public static java.time.Duration getDurationWithDefault(com.typesafe.config.Config config,
                                                        java.lang.String path,
                                                        java.time.Duration defaultValue)

return numeric config value with default

Parameters:

config - typesafe config to read value from

path - path of the config value

Returns:

config value

getLongWithDefault

public static long getLongWithDefault(com.typesafe.config.Config config,
                                      java.lang.String path,
                                      long defaultValue)

return long config value with default

Parameters:

config - typesafe config to read value from

path - path of the config value

Returns:

config value

getBooleanWithDefault

public static boolean getBooleanWithDefault(com.typesafe.config.Config config,
                                            java.lang.String path,
                                            java.lang.Boolean defaultValue)

return boolean config value with default

Parameters:

config - typesafe config to read value from

path - path of the config value

Returns:

config value

getStringMap

public static java.util.Map<java.lang.String,java.lang.String> getStringMap(com.typesafe.config.Config config)

return a String map config value where the key and value are both simple String

Parameters:

config - the typesafe config containing the String map

Returns:

the map value

getChronoUnit

public static java.time.temporal.ChronoUnit getChronoUnit(java.lang.String timeResolutionStr)

convert ChronoUnit String to ChronoUnit enum

Parameters:

timeResolutionStr - the timeResolution String

Returns:

validateTimestampPatternWithEpoch

public static void validateTimestampPatternWithEpoch(java.lang.String fieldName,
                                                     java.lang.String fieldValue,
                                                     java.lang.String timestampPattern)

Check if the input timestamp pattern is valid by checking for epoch/epoch_millis and then invoking the DateTimeFormatter.

Parameters:

fieldName - Field name where present to throw a meaningful error message

timestampPattern - The timestamp pattern string

validateTimestampPattern

public static void validateTimestampPattern(java.lang.String fieldName,
                                            java.lang.String fieldValue,
                                            java.lang.String timestampPattern)

Check if the input timestamp pattern is valid by invoking the DateTimeFormatter.

Parameters:

fieldName - Field name where present to throw a meaningful error message

timestampPattern - The timestamp pattern string

getStringList

public static java.util.List<java.lang.String> getStringList(com.typesafe.config.Config config,
                                                             java.lang.String path)

return a String list config value where the value can be either a single String or String list

Parameters:

config - the typesafe config to read value from

path - path of the config value

Returns:

config value

getHoconString

public static java.lang.String getHoconString(com.typesafe.config.Config config,
                                              java.lang.String path)

Get the typesafe ConfigValue.render() with given path

Parameters:

config - the typesafe object to read value from

path - the path

Returns:

String representation for the ConfigValue, and null if the path does not exist