1d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen/*
2d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * Copyright 2009 Mike Cumings
3d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen *
4d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * Licensed under the Apache License, Version 2.0 (the "License");
5d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * you may not use this file except in compliance with the License.
6d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * You may obtain a copy of the License at
7d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen *
8d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen *   http://www.apache.org/licenses/LICENSE-2.0
9d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen *
10d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * Unless required by applicable law or agreed to in writing, software
11d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * distributed under the License is distributed on an "AS IS" BASIS,
12d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * See the License for the specific language governing permissions and
14d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * limitations under the License.
15d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen */
16d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen
17d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chenpackage com.kenai.jbosh;
18d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen
19d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen/**
20d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * Exception class used by the BOSH API to minimize the number of checked
21d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * exceptions which must be handled by the user of the API.
22d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen */
23d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chenpublic class BOSHException extends Exception {
24d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen
25d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen    /**
26d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen     * Servial version UID.
27d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen     */
28d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen    private static final long serialVersionUID = 1L;
29d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen
30d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen    /**
31d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen     * Creates a new exception isntance with the specified descriptive message.
32d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen     *
33d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen     * @param msg description of the exceptional condition
34d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen     */
35d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen    public BOSHException(final String msg) {
36d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen        super(msg);
37d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen    }
38d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen
39d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen    /**
40d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen     * Creates a new exception isntance with the specified descriptive
41d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen     * message and the underlying root cause of the exceptional condition.
42d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen     *
43d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen     * @param msg description of the exceptional condition
44d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen     * @param cause root cause or instigator of the condition
45d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen     */
46d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen    public BOSHException(final String msg, final Throwable cause) {
47d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen        super(msg, cause);
48d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen    }
49d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen
50d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen}
51