Home | History | Annotate | Download | only in jbosh
      1 /*
      2  * Copyright 2009 Mike Cumings
      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 com.kenai.jbosh;
     18 
     19 /**
     20  * Exception class used by the BOSH API to minimize the number of checked
     21  * exceptions which must be handled by the user of the API.
     22  */
     23 public class BOSHException extends Exception {
     24 
     25     /**
     26      * Servial version UID.
     27      */
     28     private static final long serialVersionUID = 1L;
     29 
     30     /**
     31      * Creates a new exception isntance with the specified descriptive message.
     32      *
     33      * @param msg description of the exceptional condition
     34      */
     35     public BOSHException(final String msg) {
     36         super(msg);
     37     }
     38 
     39     /**
     40      * Creates a new exception isntance with the specified descriptive
     41      * message and the underlying root cause of the exceptional condition.
     42      *
     43      * @param msg description of the exceptional condition
     44      * @param cause root cause or instigator of the condition
     45      */
     46     public BOSHException(final String msg, final Throwable cause) {
     47         super(msg, cause);
     48     }
     49 
     50 }
     51