net.morimekta.providence.config

Class ResourceConfigSupplier<Message extends PMessage<Message,Field>,Field extends PField>

java.lang.Object

net.morimekta.providence.config.ConfigSupplier<Message,Field>

net.morimekta.providence.config.ResourceConfigSupplier<Message,Field>

All Implemented Interfaces:

Supplier<Message>

public class ResourceConfigSupplier<Message extends PMessage<Message,Field>,Field extends PField>
extends ConfigSupplier<Message,Field>

A supplier to get a config (aka message) from a resource location. This is a fixed static supplier, so listening to changes will never do anything.

     ConfigSupplier<Service, Service._Field> supplier =
             new ResourceConfigSupplier<>(resourceName, Service.kDescriptor);
 

Constructor Summary

Constructors

Constructor and Description
ResourceConfigSupplier(String resourceName, PMessageDescriptor<Message,Field> descriptor) Create a config that wraps a providence message instance.

Method Summary

Modifier and Type	Method and Description
void	addListener(ConfigListener<Message,Field> listener) Add a listener to changes to this config.
void	removeListener(ConfigListener<Message,Field> listener) Remove a config change listener.

Methods inherited from class net.morimekta.providence.config.ConfigSupplier

get, set

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceConfigSupplier

public ResourceConfigSupplier(String resourceName,
                              PMessageDescriptor<Message,Field> descriptor)
                       throws ProvidenceConfigException

Create a config that wraps a providence message instance. This message will be exposed without any key prefix. Note that reading from properties are never strict.

Parameters:

resourceName - The resource name to load.

descriptor - The message type descriptor.

Throws:

ProvidenceConfigException - If message overriding failed

Method Detail

addListener

public void addListener(ConfigListener<Message,Field> listener)

Description copied from class: ConfigSupplier

Add a listener to changes to this config. Note that this will store a weak reference to the listener instance, so the one adding the listener must make sure the listener is not GC'd.

Overrides:

addListener in class ConfigSupplier<Message extends PMessage<Message,Field>,Field extends PField>

Parameters:

listener - The config change listener to be added.

removeListener

public void removeListener(ConfigListener<Message,Field> listener)

Description copied from class: ConfigSupplier

Remove a config change listener.

Overrides:

removeListener in class ConfigSupplier<Message extends PMessage<Message,Field>,Field extends PField>

Parameters:

listener - The config change listener to be removed.