View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *     http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
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://commons.apache.org/configuration/team-list.html">Commons
35   * Configuration team</a>
36   * @version $Id: ConfigurationErrorListener.java 1207610 2011-11-28 21:06:22Z 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} 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  }