com.addthis.codec.jackson

Class CodecJackson

java.lang.Object

com.addthis.codec.jackson.CodecJackson

@Beta
public class CodecJackson
extends Object

Wrapper over an object mapper, plugin registry, global config, and a validator. Provides methods for constructing objects that automatically perform validation, and bridge hocon strings to jackson construction. Normally obtained either from Jackson.defaultCodec() or used indirectly from the static helper methods in Configs.

Constructor Summary

Constructors

Constructor and Description
CodecJackson(com.fasterxml.jackson.databind.ObjectMapper objectMapper, PluginRegistry pluginRegistry, com.typesafe.config.Config globalDefaults, javax.validation.Validator validator)

Method Summary

Methods

Modifier and Type	Method and Description
<T> T	decodeObject(Class<T> type, com.typesafe.config.Config config) Instantiate an object of the requested type based on the provided config.
<T> T	decodeObject(Class<T> type, com.typesafe.config.ConfigValue configValue)
<T> T	decodeObject(Class<T> type, com.fasterxml.jackson.databind.JsonNode jsonNode)
<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.
<T> T	decodeObject(com.typesafe.config.Config config) Instantiate an object without a compile time expected type.
<T> T	decodeObject(String configText) Instantiate an object without a compile time expected type.
<T> T	decodeObject(String category, com.typesafe.config.Config config) Instantiate an object of the requested category based on the provided config.
<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.
com.typesafe.config.Config	getGlobalDefaults()
com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
PluginRegistry	getPluginRegistry()
javax.validation.Validator	getValidator()
<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).
<T> T	newDefault(String category) Construct an object of the requested plugin category based on the default type and values
<T> T	validate(T value)
CodecJackson	withConfig(com.typesafe.config.Config newGlobalDefaults)
CodecJackson	withOverrides(com.typesafe.config.Config overrides)

Methods inherited from class java.lang.Object

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

Constructor Detail

CodecJackson

public CodecJackson(com.fasterxml.jackson.databind.ObjectMapper objectMapper,
            PluginRegistry pluginRegistry,
            com.typesafe.config.Config globalDefaults,
            javax.validation.Validator validator)

Method Detail

withConfig

public CodecJackson withConfig(com.typesafe.config.Config newGlobalDefaults)

withOverrides

public CodecJackson withOverrides(com.typesafe.config.Config overrides)

getObjectMapper

public com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()

getPluginRegistry

public PluginRegistry getPluginRegistry()

getGlobalDefaults

public com.typesafe.config.Config getGlobalDefaults()

getValidator

public javax.validation.Validator getValidator()

newDefault

public <T> T newDefault(@Nonnull
               Class<T> type)
             throws com.fasterxml.jackson.core.JsonProcessingException,
                    IOException

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

Throws:

com.fasterxml.jackson.core.JsonProcessingException

IOException

decodeObject

public <T> T decodeObject(@Nonnull
                 Class<T> type,
                 com.typesafe.config.ConfigValue configValue)
               throws com.fasterxml.jackson.core.JsonProcessingException,
                      IOException

Throws:

com.fasterxml.jackson.core.JsonProcessingException

IOException

decodeObject

public <T> T decodeObject(@Nonnull
                 Class<T> type,
                 com.fasterxml.jackson.databind.JsonNode jsonNode)
               throws com.fasterxml.jackson.core.JsonProcessingException

Throws:

com.fasterxml.jackson.core.JsonProcessingException

newDefault

public <T> T newDefault(@Nonnull
               String category)
             throws com.fasterxml.jackson.core.JsonProcessingException,
                    IOException

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

Throws:

com.fasterxml.jackson.core.JsonProcessingException

IOException

decodeObject

public <T> T decodeObject(@Nonnull
                 String category,
                 @Syntax(value="HOCON")
                 String configText)
               throws com.fasterxml.jackson.core.JsonProcessingException,
                      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:

com.fasterxml.jackson.core.JsonProcessingException

IOException

decodeObject

public <T> T decodeObject(@Nonnull
                 Class<T> type,
                 @Syntax(value="HOCON")
                 String configText)
               throws com.fasterxml.jackson.core.JsonProcessingException,
                      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:

com.fasterxml.jackson.core.JsonProcessingException

IOException

decodeObject

public <T> T decodeObject(@Nonnull
                 String category,
                 @Nonnull
                 com.typesafe.config.Config config)
               throws com.fasterxml.jackson.core.JsonProcessingException,
                      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:

com.fasterxml.jackson.core.JsonProcessingException

IOException

decodeObject

public <T> T decodeObject(@Nonnull
                 Class<T> type,
                 com.typesafe.config.Config config)
               throws com.fasterxml.jackson.core.JsonProcessingException,
                      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:

com.fasterxml.jackson.core.JsonProcessingException

IOException

decodeObject

public <T> T decodeObject(@Syntax(value="HOCON")
                 String configText)
               throws com.fasterxml.jackson.core.JsonProcessingException,
                      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:

com.fasterxml.jackson.core.JsonProcessingException

IOException

decodeObject

public <T> T decodeObject(com.typesafe.config.Config config)
               throws com.fasterxml.jackson.core.JsonProcessingException,
                      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:

com.fasterxml.jackson.core.JsonProcessingException

IOException

validate

public <T> T validate(T value)