com.alanbuttars.commons.config.stub

Class WatchFileJsonImplStub

java.lang.Object

com.alanbuttars.commons.config.stub.WatchFileJsonImplStub

public class WatchFileJsonImplStub
extends Object

Intermediate stub ultimately used to create a ConfigurationJsonImpl.

Author:

Alan Buttars

Field Summary

Fields

Modifier and Type	Field and Description
protected EventBus	eventBus
protected File	file
protected String	sourceId

Method Summary

Methods

Modifier and Type	Method and Description
<T> ConfigurationJsonImpl<T>	mappedTo(Class<T> clazz) Instructs the configuration object to map the contents of the JSON file to an object of the given type.
<C> ConfigurationJsonCollectionImpl<C>	mappedTo(com.fasterxml.jackson.core.type.TypeReference<C> typeReference) Instructs the configuration object to map the contents of the JSON file to an object of the given type reference.

Methods inherited from class java.lang.Object

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

Field Detail

sourceId

protected final String sourceId

file

protected final File file

eventBus

protected final EventBus eventBus

Method Detail

mappedTo

public <T> ConfigurationJsonImpl<T> mappedTo(Class<T> clazz)
                                  throws IOException

Instructs the configuration object to map the contents of the JSON file to an object of the given type. For example:

 ConfigurationJsonImpl<User> config = Watch.json("/path/to/user.json").mappedTo(User.class);
 User user = config.getValue();
 

Parameters:

clazz - Non-null type

Throws:

IOException - On I/O parsing the JSON file

mappedTo

public <C> ConfigurationJsonCollectionImpl<C> mappedTo(com.fasterxml.jackson.core.type.TypeReference<C> typeReference)
                                            throws IOException

Instructs the configuration object to map the contents of the JSON file to an object of the given type reference. This method should be used when the JSON file contains a collection. For example:

 ConfigurationJsonImpl<List<User>> config = Watch.json("/path/to/users.json").mappedTo(new TypeReference<List<User>>() {
 });
 List<User> users = config.getValue();
 

Parameters:

typeReference - Non-null type reference

Throws:

IOException - On I/O parsing the JSON file