Package com.arpnetworking.configuration.jackson

Class BaseJacksonConfiguration

java.lang.Object

com.arpnetworking.configuration.BaseConfiguration

com.arpnetworking.configuration.jackson.BaseJacksonConfiguration

All Implemented Interfaces:

Configuration

Direct Known Subclasses:

DynamicConfiguration, StaticConfiguration

public abstract class BaseJacksonConfiguration
extends BaseConfiguration

Common base class for Configuration implementations based on Jackson's ObjectMapper.

Author:

Ville Koskela (ville dot koskela at inscopemetrics dot com)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	BaseJacksonConfiguration.Builder<T extends BaseJacksonConfiguration.Builder<?,?>,S extends Configuration>	Builder implementation for BaseJacksonConfiguration.

Field Summary

Fields

Modifier and Type	Field	Description
protected final com.fasterxml.jackson.databind.ObjectMapper	_objectMapper

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaseJacksonConfiguration(BaseJacksonConfiguration.Builder<?,?> builder)	Protected constructor.

Method Summary

Modifier and Type	Method	Description
<T> Optional<T>	getAs(Class<? extends T> clazz)	Generic object accessor.
<T> Optional<T>	getAs(Type type)	Generic object accessor.
protected abstract JsonNodeSource	getJsonSource()	Accessor for active root JsonNodeSource instance.
Optional<String>	getProperty(String name)	Retrieve the value of a particular property by its name.
<T> Optional<T>	getPropertyAs(String name, Class<? extends T> clazz)	Generic object accessor.
<T> Optional<T>	getPropertyAs(String name, Type type)	Generic object accessor.
Object	toLogValue()	Generate a Steno log compatible representation.

Methods inherited from class com.arpnetworking.configuration.BaseConfiguration

getAs, getAs, getProperty, getPropertyAs, getPropertyAs, getPropertyAsBoolean, getPropertyAsBoolean, getPropertyAsDouble, getPropertyAsDouble, getPropertyAsFloat, getPropertyAsFloat, getPropertyAsInteger, getPropertyAsInteger, getPropertyAsLong, getPropertyAsLong, getPropertyAsShort, getPropertyAsShort, getRequiredAs, getRequiredAs, getRequiredProperty, getRequiredPropertyAs, getRequiredPropertyAs, getRequiredPropertyAsBoolean, getRequiredPropertyAsDouble, getRequiredPropertyAsFloat, getRequiredPropertyAsInteger, getRequiredPropertyAsLong, getRequiredPropertyAsShort, toString

Methods inherited from class java.lang.Object

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

Field Details

_objectMapper

protected final com.fasterxml.jackson.databind.ObjectMapper _objectMapper

Constructor Details

BaseJacksonConfiguration

protected BaseJacksonConfiguration(BaseJacksonConfiguration.Builder<?,?> builder)

Protected constructor.

Parameters:

builder - The BaseJacksonConfiguration.Builder instance to construct from.

Method Details

getProperty

public Optional<String> getProperty(String name)

Description copied from interface: Configuration

Retrieve the value of a particular property by its name.

Parameters:

name - The name of the property value to retrieve.

Returns:

Returns the property value or Optional.empty() if the property name has not been defined.

getPropertyAs

public <T> Optional<T> getPropertyAs(String name,
 Class<? extends T> clazz)
                              throws IllegalArgumentException

Description copied from interface: Configuration

Generic object accessor.

Type Parameters:

T - The type to return.

Parameters:

name - The name of the property value to retrieve.

clazz - The type of the object to instantiate.

Returns:

Returns the property value or Optional.empty() if the property name has not been defined.

Throws:

IllegalArgumentException - if the value cannot be converted to an instance of Configuration.

getAs

public <T> Optional<T> getAs(Class<? extends T> clazz)
                      throws IllegalArgumentException

Description copied from interface: Configuration

Generic object accessor.

Type Parameters:

T - The type to return.

Parameters:

clazz - The type of the object to instantiate.

Returns:

Returns the entire configuration as an instance of Configuration.

Throws:

IllegalArgumentException - if the value cannot be converted to an instance of Configuration.

getPropertyAs

public <T> Optional<T> getPropertyAs(String name,
 Type type)
                              throws IllegalArgumentException

Description copied from interface: Configuration

Generic object accessor.

Type Parameters:

T - The type to return.

Parameters:

name - The name of the property value to retrieve.

type - The type of the object to instantiate.

Returns:

Returns the property value or Optional.empty() if the property name has not been defined.

Throws:

IllegalArgumentException - if the value cannot be converted to an instance of Configuration.

getAs

public <T> Optional<T> getAs(Type type)
                      throws IllegalArgumentException

Description copied from interface: Configuration

Generic object accessor.

Type Parameters:

T - The type to return.

Parameters:

type - The type of the object to instantiate.

Returns:

Returns the entire configuration as an instance of Configuration.

Throws:

IllegalArgumentException - if the value cannot be converted to an instance of Configuration.

toLogValue

public Object toLogValue()

Description copied from class: BaseConfiguration

Generate a Steno log compatible representation.

Overrides:

toLogValue in class BaseConfiguration

Returns:

Steno log compatible representation.

getJsonSource

protected abstract JsonNodeSource getJsonSource()

Accessor for active root JsonNodeSource instance.

Returns:

Instance of JsonNodeSource.