net.morimekta.providence.config

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

java.lang.Object

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

All Implemented Interfaces:

Supplier<Message>, ReloadableSupplier<Message>

public class MessageSupplier<Message extends PMessage<Message,Field>,Field extends PField>
extends Object
implements ReloadableSupplier<Message>

A supplier of a providence message config based on a message reader. For reading a simple message from a readable file, use the FileMessageReader with the PrettySerializer: NOTE: The message reader will be closed after every read, so only message readers that can be reset that way can be supported, e.g. FileMessageReader. MessageSupplier supplier = new MessageSupplier( MyConfig.kDescriptor, new FileMessageReader(configFile, new PrettySerializer()));

Constructor Summary

Constructors

Constructor and Description
MessageSupplier(PMessageDescriptor<Message,Field> descriptor, MessageReader reader) Create a config that wraps a providence message instance.

Method Summary

Modifier and Type	Method and Description
Message	get() Get the message enclosed in the config wrapper.
void	reload() Reload the message into the config.

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageSupplier

public MessageSupplier(PMessageDescriptor<Message,Field> descriptor,
                       MessageReader reader)
                throws IOException

Create a config that wraps a providence message instance. This message will be exposed without any key prefix.

Parameters:

descriptor - The message descriptor of the config root message.

reader - The message reader containing the config.

Throws:

IOException - If message read failed.

SerializerException - If message deserialization failed.

Method Detail

get

public Message get()

Get the message enclosed in the config wrapper.

Specified by:

get in interface Supplier<Message extends PMessage<Message,Field>>

Returns:

The message.

reload

public void reload()

Reload the message into the config.

Specified by:

reload in interface ReloadableSupplier<Message extends PMessage<Message,Field>>