com.addthis.codec.config

Class Configs

java.lang.Object

com.addthis.codec.config.Configs

@Beta
public final class Configs
extends Object

Method Summary

Methods

Modifier and Type	Method and Description
static <T> T	decodeObject(Class<T> type, com.typesafe.config.Config config) Instantiate an object of the requested type based on the provided config.
static <T> T	decodeObject(Class<T> type, String configText) Tries to parse the string as an isolated typesafe-config object, tries to resolve it, and then calls decodeObject(Class, Config) with the resultant config and the passed in type.
static <T> T	decodeObject(com.typesafe.config.Config config) Instantiate an object without a compile time expected type.
static <T> T	decodeObject(String configText) Instantiate an object without a compile time expected type.
static <T> T	decodeObject(String category, com.typesafe.config.Config config) Instantiate an object of the requested category based on the provided config.
static <T> T	decodeObject(String category, String configText) Tries to parse the string as an isolated typesafe-config object, tries to resolve it, and then calls decodeObject(String, Config) with the resultant config and the passed in category.
static com.typesafe.config.ConfigValue	expandSugar(Class<?> type, com.typesafe.config.ConfigValue config, PluginRegistry pluginRegistry)
static com.typesafe.config.ConfigValue	expandSugar(com.typesafe.config.Config config, PluginRegistry pluginRegistry)
static <T> T	newDefault(Class<T> type) Construct an object of the requested type based on the default values and types (if the requested is not a concrete class).
static <T> T	newDefault(String category) Construct an object of the requested plugin category based on the default type and values

Methods inherited from class java.lang.Object

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

Method Detail

newDefault

public static <T> T newDefault(@Nonnull
               Class<T> type)
                    throws IOException

Construct an object of the requested type based on the default values and types (if the requested is not a concrete class).

Throws:

IOException

newDefault

public static <T> T newDefault(@Nonnull
               String category)
                    throws IOException

Construct an object of the requested plugin category based on the default type and values

Throws:

IOException

decodeObject

public static <T> T decodeObject(@Nonnull
                 Class<T> type,
                 @Nonnull
                 com.typesafe.config.Config config)
                      throws IOException

Instantiate an object of the requested type based on the provided config. The config should only contain field and type information for the object to be constructed. Global defaults, plugin configuration, etc, are provided by this CodecConfig instance's globalConfig and pluginRegistry fields.

Throws:

IOException

decodeObject

public static <T> T decodeObject(@Nonnull
                 String category,
                 @Nonnull
                 com.typesafe.config.Config config)
                      throws IOException

Instantiate an object of the requested category based on the provided config. The config should only contain field and type information for the object to be constructed. Global defaults, plugin configuration, etc, are provided by this CodecConfig instance's globalConfig and pluginRegistry fields.

Throws:

IOException

decodeObject

public static <T> T decodeObject(@Nonnull
                 Class<T> type,
                 @Syntax(value="HOCON")@Nonnull
                 String configText)
                      throws IOException

Tries to parse the string as an isolated typesafe-config object, tries to resolve it, and then calls decodeObject(Class, Config) with the resultant config and the passed in type. Pretty much just a convenience function for simple use cases that don't want to care about how ConfigFactory works.

Throws:

IOException

decodeObject

public static <T> T decodeObject(@Nonnull
                 String category,
                 @Syntax(value="HOCON")@Nonnull
                 String configText)
                      throws IOException

Tries to parse the string as an isolated typesafe-config object, tries to resolve it, and then calls decodeObject(String, Config) with the resultant config and the passed in category. Pretty much just a convenience function for simple use cases that don't want to care about how ConfigFactory works.

Throws:

IOException

decodeObject

public static <T> T decodeObject(@Syntax(value="HOCON")
                 String configText)
                      throws IOException

Instantiate an object without a compile time expected type. This expects a config of the form "{plugin-category: {...}}". ie. there should be exactly one top level key and that key should be a valid, loaded, plug-in category.

Throws:

IOException

decodeObject

public static <T> T decodeObject(com.typesafe.config.Config config)
                      throws IOException

Instantiate an object without a compile time expected type. This expects a config of the form "{plugin-category: {...}}". ie. there should be exactly one top level key and that key should be a valid, loaded, plug-in category.

Throws:

IOException

expandSugar

public static com.typesafe.config.ConfigValue expandSugar(com.typesafe.config.Config config,
                                          PluginRegistry pluginRegistry)

expandSugar

public static com.typesafe.config.ConfigValue expandSugar(Class<?> type,
                                          com.typesafe.config.ConfigValue config,
                                          PluginRegistry pluginRegistry)