org.apache.commons.configuration2.builder

Interface ReloadingDetectorFactory

All Known Implementing Classes:

DefaultReloadingDetectorFactory

public interface ReloadingDetectorFactory

Definition of an interface for objects which can create a ReloadingDetector.

This interface is used by ReloadingFileBasedConfigurationBuilder to create detector objects for configuration sources supporting reloading.

Since:

2.0

Method Summary

Modifier and Type	Method and Description
ReloadingDetector	createReloadingDetector(FileHandler handler, FileBasedBuilderParametersImpl params) Creates a new ReloadingDetector object based on the passed in parameters.

Method Detail

createReloadingDetector

ReloadingDetector createReloadingDetector(FileHandler handler,
                                          FileBasedBuilderParametersImpl params)
                                   throws ConfigurationException

Creates a new ReloadingDetector object based on the passed in parameters. The FileHandler points to the file to be monitored. (It may be different from the FileHandler managed by the parameters object.) The FileBasedBuilderParametersImpl object may contain additional information for configuring the detector, e.g. a refresh delay.

Parameters:

handler - the handler of the file to be monitored

params - parameters related to file-based configurations

Returns:

the newly created ReloadingDetector

Throws:

ConfigurationException - if an error occurs