net.morimekta.providence.config

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

java.lang.Object

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

All Implemented Interfaces:

com.google.common.base.Supplier<MessageConfig<Message,Field>>

public class MessageConfigSupplier<Message extends PMessage<Message,Field>,Field extends PField>
extends Object
implements com.google.common.base.Supplier<MessageConfig<Message,Field>>

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. MessageConfigSupplier supplier = new MessageConfigSupplier( prefix, MyConfig.kDescriptor, new FileMessageReader(configFile, new PrettySerializer()));

Constructor Summary

Constructors

Constructor and Description
MessageConfigSupplier(String prefix, PStructDescriptor<Message,Field> descriptor, MessageReader reader) Create a config that wraps a providence message instance.

Method Summary

Modifier and Type	Method and Description
MessageConfig<Message,Field>	get() Get the message enclosed in the config wrapper.
String	getPrefix() Get the key prefix used 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

MessageConfigSupplier

public MessageConfigSupplier(String prefix,
                             PStructDescriptor<Message,Field> descriptor,
                             MessageReader reader)
                      throws IOException,
                             SerializerException

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

Parameters:

prefix - The config prefix.

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

getPrefix

public String getPrefix()

Get the key prefix used in the config wrapper. All keys in the message structure is prefixed by this value.

Returns:

The key prefix.

get

public MessageConfig<Message,Field> get()

Get the message enclosed in the config wrapper.

Specified by:

get in interface com.google.common.base.Supplier<MessageConfig<Message extends PMessage<Message,Field>,Field extends PField>>

Returns:

The message.

reload

public void reload()

Reload the message into the config.