View Javadoc

1   /**
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *     http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing, software
13   * distributed under the License is distributed on an "AS IS" BASIS,
14   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15   * See the License for the specific language governing permissions and
16   * limitations under the License.
17   */
18  package org.apache.hadoop.hbase.errorhandling;
19  
20  import org.apache.hadoop.classification.InterfaceAudience;
21  import org.apache.hadoop.classification.InterfaceStability;
22  
23  /**
24   * The ForeignExceptionListener is an interface for objects that can receive a ForeignException.
25   * <p>
26   * Implementations must be thread-safe, because this is expected to be used to propagate exceptions
27   * from foreign threads.
28   */
29  @InterfaceAudience.Private
30  @InterfaceStability.Evolving
31  public interface ForeignExceptionListener {
32  
33    /**
34     * Receive a ForeignException.
35     * <p>
36     * Implementers must ensure that this method is thread-safe.
37     * @param e exception causing the error. Implementations must accept and handle null here.
38     */
39    void receive(ForeignException e);
40  }