ErrorHandler


1   // Copyright 2004, 2005 The Apache Software Foundation
2   //
3   // Licensed under the Apache License, Version 2.0 (the "License");
4   // you may not use this file except in compliance with the License.
5   // You may obtain a copy of the License at
6   //
7   //     http://www.apache.org/licenses/LICENSE-2.0
8   //
9   // Unless required by applicable law or agreed to in writing, software
10  // distributed under the License is distributed on an "AS IS" BASIS,
11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  // See the License for the specific language governing permissions and
13  // limitations under the License.
14  
15  package org.apache.hivemind;
16  
17  import org.apache.commons.logging.Log;
18  
19  /**
20   * Interface for handling recoverable errors.  Recoverable errors are often
21   * caused by improper configuration data in a module descriptor. Implementations
22   * of this interface can either be brittle (throw an ApplicationRuntimeException
23   * immediately) or "mellow" and just log the exception (with the expectation that
24   * a more drastic failure may follow later).
25   *
26   * @author Howard Lewis Ship
27   */
28  public interface ErrorHandler
29  {
30      /**
31       * Handle a recoverable error. May use the log to log the error (and location),
32       * or may throw a runtime exception (probably ApplicationRuntimeException).
33       * 
34       * @param log the log used for logging the error
35       * @param message the message to display
36       * @param location location associated with the error if known (possibly null)
37       * @param cause the underlying exception that caused the error if known (possibly null)
38       */
39      public void error(Log log, String   message, Location location, Throwable   cause);
40  }
41
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags