View Javadoc

1   /**
2    *  Copyright 2003-2007 Greg Luck
3    *
4    *  Licensed under the Apache License, Version 2.0 (the "License");
5    *  you may not use this file except in compliance with the License.
6    *  You may obtain a copy of the License at
7    *
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    *
10   *  Unless required by applicable law or agreed to in writing, software
11   *  distributed under the License is distributed on an "AS IS" BASIS,
12   *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   *  See the License for the specific language governing permissions and
14   *  limitations under the License.
15   */
16  
17  package net.sf.ehcache.constructs.asynchronous;
18  
19  
20  
21  
22  
23  /**
24   * Thrown when an asynchronous command has somehow failed. This Exception has several subclasses
25   * for the different types of exception.
26   * <p/>
27   * The {@link net.sf.ehcache.constructs.asynchronous.Command} will not accept any more {@link net.sf.ehcache.constructs.asynchronous.Command#execute()} attempts, so it will never be able
28   * to complete its task.
29   * @author <a href="mailto:gluck@thoughtworks.com">Greg Luck</a>
30   * @version $Id: AsynchronousCommandException.java 512 2007-07-10 09:18:45Z gregluck $
31   */
32  public class AsynchronousCommandException extends Exception {
33  
34      /**
35       * Constructs a new exception with the specified detail message.  The
36       * cause is not initialized, and may subsequently be initialized by
37       * a call to {@link #initCause}.
38       *
39       * @param message the detail message. The detail message is saved for
40       *                later retrieval by the {@link #getMessage()} method.
41       */
42      public AsynchronousCommandException(String message) {
43          super(message);
44      }
45  
46      /**
47       * Constructs a new exception with the specified detail message and
48       * cause.  <p>Note that the detail message associated with
49       * <code>cause</code> is <i>not</i> automatically incorporated in
50       * this exception's detail message.
51       *
52       * @param message the detail message (which is saved for later retrieval
53       *                by the {@link #getMessage()} method).
54       * @param cause   the cause (which is saved for later retrieval by the
55       *                {@link #getCause()} method).  (A <tt>null</tt> value is
56       *                permitted, and indicates that the cause is nonexistent or
57       *                unknown.)
58       */
59      public AsynchronousCommandException(String message, Throwable cause) {
60          super(message, cause);
61      }
62  }