1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17 package org.apache.commons.configuration.event;
18
19 /***
20 * <p>
21 * An event listener interface to be implemented by observers that are
22 * interested in internal errors caused by processing of configuration
23 * properties.
24 * </p>
25 * <p>
26 * Some configuration classes use an underlying storage where each access of a
27 * property can cause an exception. In earlier versions of this library such
28 * exceptions were typically ignored. By implementing this interface and
29 * registering at a configuration object as an error listener it is now possible
30 * for clients to receive notifications about those internal problems.
31 * </p>
32 *
33 * @author <a
34 * href="http://jakarta.apache.org/commons/configuration/team-list.html">Commons
35 * Configuration team</a>
36 * @version $Id: ConfigurationErrorListener.java 495926 2007-01-13 17:06:29Z oheger $
37 * @since 1.4
38 * @see ConfigurationErrorEvent
39 */
40 public interface ConfigurationErrorListener
41 {
42 /***
43 * Notifies this listener that in an observed configuration an error
44 * occurred. All information available about this error, including the
45 * causing <code>Throwable</code> object, can be obtained from the passed
46 * in event object.
47 *
48 * @param event the event object with information about the error
49 */
50 void configurationError(ConfigurationErrorEvent event);
51 }