net.morimekta.providence.config

Class ReferenceConfigSupplier<RefMessage extends PMessage<RefMessage,RefField>,RefField extends PField,ParentMessage extends PMessage<ParentMessage,ParentField>,ParentField extends PField>

java.lang.Object

net.morimekta.providence.config.impl.UpdatingConfigSupplier<RefMessage,RefField>

net.morimekta.providence.config.ReferenceConfigSupplier<RefMessage,RefField,ParentMessage,ParentField>

All Implemented Interfaces:

Supplier<RefMessage>, ConfigSupplier<RefMessage,RefField>

public class ReferenceConfigSupplier<RefMessage extends PMessage<RefMessage,RefField>,RefField extends PField,ParentMessage extends PMessage<ParentMessage,ParentField>,ParentField extends PField>
extends UpdatingConfigSupplier<RefMessage,RefField>

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<>(referencePath, Service.kDescriptor);
 

Constructor Summary

Constructors

Constructor and Description
ReferenceConfigSupplier(String referencePath, ConfigSupplier<ParentMessage,ParentField> parent) Create a config that wraps a providence message instance, and fetches a message from within that parent config.
ReferenceConfigSupplier(String referencePath, ConfigSupplier<ParentMessage,ParentField> parent, Clock clock) Create a config that wraps a providence message instance, and fetches a message from within that parent config.

Method Summary

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

Methods inherited from class net.morimekta.providence.config.impl.UpdatingConfigSupplier

addListener, configTimestamp, get, removeListener, set

Methods inherited from class java.lang.Object

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

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

snapshot

Constructor Detail

ReferenceConfigSupplier

public ReferenceConfigSupplier(@Nonnull
                               String referencePath,
                               @Nonnull
                               ConfigSupplier<ParentMessage,ParentField> parent)
                        throws ProvidenceConfigException

Create a config that wraps a providence message instance, and fetches a message from within that parent config. It is not allowed to have it return a null, meaning for the reference config to be valid, the reference must exist.

Parameters:

referencePath - The resource name to load.

parent - The message type descriptor.

Throws:

ProvidenceConfigException - If message overriding failed

ReferenceConfigSupplier

public ReferenceConfigSupplier(String referencePath,
                               ConfigSupplier<ParentMessage,ParentField> parent,
                               Clock clock)
                        throws ProvidenceConfigException

Create a config that wraps a providence message instance, and fetches a message from within that parent config. It is not allowed to have it return a null, meaning for the reference config to be valid, the reference must exist.

Parameters:

referencePath - The resource name to load.

parent - The message type descriptor.

clock - The clock to use for timing.

Throws:

ProvidenceConfigException - If message overriding failed

Method Detail

toString

public String toString()

Overrides:

toString in class Object

getName

public String getName()

Description copied from interface: ConfigSupplier

Get a simple descriptive name for this config supplier.

Returns:

The supplier name.