net.morimekta.providence.config.impl

Class UpdatingConfigSupplier<M extends net.morimekta.providence.PMessage<M>>

java.lang.Object

net.morimekta.providence.config.impl.UpdatingConfigSupplier<M>

All Implemented Interfaces:

Supplier<M>, ConfigSupplier<M>

Direct Known Subclasses:

OverrideConfigSupplier, ProvidenceConfigSupplier, ReferenceConfigSupplier, TestConfigSupplier

public abstract class UpdatingConfigSupplier<M extends net.morimekta.providence.PMessage<M>>
extends Object
implements ConfigSupplier<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

Modifier	Constructor and Description
protected	UpdatingConfigSupplier(Clock clock) Initialize supplier with empty config.

Method Summary

Modifier and Type	Method and Description
void	addListener(ConfigListener<M> listener) Add a listener to changes to this config.
long	configTimestamp() Get the last update time as a millisecond timestamp.
M	get()
Clock	getClock()
<RM extends net.morimekta.providence.PMessage<RM>> ConfigSupplier<RM>	reference(net.morimekta.providence.descriptor.PField... fields) Give a reference to a sub-config based on field selection.
void	removeListener(ConfigListener<M> 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

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

getName, override, override, snapshot

Constructor Detail

UpdatingConfigSupplier

protected UpdatingConfigSupplier(@Nonnull
                                 Clock clock)

Initialize supplier with empty config.

Parameters:

clock - The clock to use in timing config loads.

Method Detail

get

@Nonnull
public final M get()

Specified by:

get in interface Supplier<M extends net.morimekta.providence.PMessage<M>>

reference

public <RM extends net.morimekta.providence.PMessage<RM>> ConfigSupplier<RM> reference(net.morimekta.providence.descriptor.PField... fields)
                                                                                throws ConfigException

Description copied from interface: ConfigSupplier

Give a reference to a sub-config based on field selection.

Specified by:

reference in interface ConfigSupplier<M extends net.morimekta.providence.PMessage<M>>

Type Parameters:

RM - The resulting config type.

Parameters:

fields - The fields to select.

Returns:

The reference config supplier.

Throws:

ConfigException - If resolving fields failed

addListener

public void addListener(@Nonnull
                        ConfigListener<M> listener)

Description copied from interface: 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.

Specified by:

addListener in interface ConfigSupplier<M extends net.morimekta.providence.PMessage<M>>

Parameters:

listener - The config change listener to be added.

removeListener

public void removeListener(@Nonnull
                           ConfigListener<M> listener)

Description copied from interface: ConfigSupplier

Remove a config change listener.

Specified by:

removeListener in interface ConfigSupplier<M extends net.morimekta.providence.PMessage<M>>

Parameters:

listener - The config change listener to be removed.

configTimestamp

public long configTimestamp()

Description copied from interface: ConfigSupplier

Get the last update time as a millisecond timestamp.

Specified by:

configTimestamp in interface ConfigSupplier<M extends net.morimekta.providence.PMessage<M>>

Returns:

The timestamp of last update of the config.

getClock

public Clock getClock()

Specified by:

getClock in interface ConfigSupplier<M extends net.morimekta.providence.PMessage<M>>

Returns:

Get the clock used to calculate config timestamp.

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.