net.morimekta.providence.config

Class ConfigSupplier<M extends PMessage<M,F>,F extends PField>

java.lang.Object

net.morimekta.providence.config.ConfigSupplier<M,F>

All Implemented Interfaces:

Supplier<M>

Direct Known Subclasses:

OverrideConfigSupplier, ProvidenceConfigSupplier, ResourceConfigSupplier

public class ConfigSupplier<M extends PMessage<M,F>,F extends PField>
extends Object
implements Supplier<M>

A supplier and instance holder for config objects. This supplier can be listened to for changes in the config object. When something triggers a change (supplier.set(config)) that will cause a config change call to each listener regardless of if the config values actually did change.

Constructor Summary

Constructors

Constructor and Description
ConfigSupplier() Initialize supplier with empty config.
ConfigSupplier(M initialConfig) Initialize with an initial config instance.

Method Summary

Modifier and Type	Method and Description
void	addListener(ConfigListener<M,F> listener) Add a listener to changes to this config.
M	get()
void	removeListener(ConfigListener<M,F> listener) Remove a config change listener.
protected void	set(M config) Set a new config value to the supplier.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigSupplier

public ConfigSupplier()

Initialize supplier with empty config.

ConfigSupplier

public ConfigSupplier(@Nonnull
                      M initialConfig)

Initialize with an initial config instance.

Parameters:

initialConfig - The initial config instance.

Method Detail

get

@Nonnull
public final M get()

Specified by:

get in interface Supplier<M extends PMessage<M,F>>

addListener

public void addListener(ConfigListener<M,F> listener)

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.

Parameters:

listener - The config change listener to be added.

removeListener

public void removeListener(ConfigListener<M,F> listener)

Remove a config change listener.

Parameters:

listener - The config change listener to be removed.

set

protected final void set(M config)

Set a new config value to the supplier. This is protected as it is usually up to the supplier implementation to enable updating the config at later stages.

Parameters:

config - The new config instance.