Package net.morimekta.providence.config

Class ResourceConfigSupplier<Message extends net.morimekta.providence.PMessage<Message,Field>,Field extends net.morimekta.providence.descriptor.PField>

java.lang.Object

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

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

All Implemented Interfaces:

java.util.function.Supplier<Message>, ConfigSupplier<Message,Field>

public class ResourceConfigSupplier<Message extends net.morimekta.providence.PMessage<Message,Field>,Field extends net.morimekta.providence.descriptor.PField>
extends FixedConfigSupplier<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	Description
ResourceConfigSupplier(java.lang.String resourceName, net.morimekta.providence.descriptor.PMessageDescriptor<Message,Field> descriptor)	Create a config that wraps a providence message instance.
ResourceConfigSupplier(java.lang.String resourceName, net.morimekta.providence.descriptor.PMessageDescriptor<Message,Field> descriptor, java.time.Clock clock)	Create a config that wraps a providence message instance.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getName()	Get a simple descriptive name for this config supplier.

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

snapshot

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

addListener, configTimestamp, get, removeListener, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceConfigSupplier

public ResourceConfigSupplier(java.lang.String resourceName,
                              net.morimekta.providence.descriptor.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

ResourceConfigSupplier

public ResourceConfigSupplier(java.lang.String resourceName,
                              net.morimekta.providence.descriptor.PMessageDescriptor<Message,Field> descriptor,
                              java.time.Clock clock)
                       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.

clock - The clock to use in timing config loads.

Throws:

ProvidenceConfigException - If message overriding failed

Method Detail

getName

public java.lang.String getName()

Description copied from interface: ConfigSupplier

Get a simple descriptive name for this config supplier.

Specified by:

getName in interface ConfigSupplier<Message extends net.morimekta.providence.PMessage<Message,Field>,Field extends net.morimekta.providence.descriptor.PField>

Overrides:

getName in class FixedConfigSupplier<Message extends net.morimekta.providence.PMessage<Message,Field>,Field extends net.morimekta.providence.descriptor.PField>

Returns:

The supplier name.