net.dempsy.distconfig

Interface PropertiesReader

All Known Implementing Classes:

ApacheVfsPropertiesReader, ClasspathPropertiesReader, ClusterInfoPropertiesReader

public interface PropertiesReader

Implementations of this interface can be used to retrieve a set of properties while optionally registering for updates when properties change.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PropertiesReader.VersionedProperties Stored Properties along with the version number.

Method Summary

Modifier and Type	Method and Description
PropertiesReader.VersionedProperties	read(PropertiesWatcher watcher) Retrieves the latest Properties file that's been registered.
boolean	supportsNotification()

Method Detail

read

PropertiesReader.VersionedProperties read(PropertiesWatcher watcher)
                                   throws IOException,
                                          UnsupportedOperationException

Retrieves the latest Properties file that's been registered.

Parameters:

watcher - if non-null the watcher will be called back when the properties change from the version provided. Upon callback the PropertiesWatcher will be unregistered. A subsequent read will need to be called in order to re-register for another change.

Returns:

the latest PropertiesReader.VersionedProperties

Throws:

IOException - if the underlying transport or storage mechanism throws an IOException

UnsupportedOperationException - if the underlying implementation doesn't support notification but watcher is not null.

supportsNotification

boolean supportsNotification()

Returns:

Whether or not the underlying implementation supports notification.