1ef39d40dSAndrew Rist /**************************************************************
2cdf0e10cSrcweir  *
3ef39d40dSAndrew Rist  * Licensed to the Apache Software Foundation (ASF) under one
4ef39d40dSAndrew Rist  * or more contributor license agreements.  See the NOTICE file
5ef39d40dSAndrew Rist  * distributed with this work for additional information
6ef39d40dSAndrew Rist  * regarding copyright ownership.  The ASF licenses this file
7ef39d40dSAndrew Rist  * to you under the Apache License, Version 2.0 (the
8ef39d40dSAndrew Rist  * "License"); you may not use this file except in compliance
9ef39d40dSAndrew Rist  * with the License.  You may obtain a copy of the License at
10ef39d40dSAndrew Rist  *
11ef39d40dSAndrew Rist  *   http://www.apache.org/licenses/LICENSE-2.0
12ef39d40dSAndrew Rist  *
13ef39d40dSAndrew Rist  * Unless required by applicable law or agreed to in writing,
14ef39d40dSAndrew Rist  * software distributed under the License is distributed on an
15ef39d40dSAndrew Rist  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16ef39d40dSAndrew Rist  * KIND, either express or implied.  See the License for the
17ef39d40dSAndrew Rist  * specific language governing permissions and limitations
18ef39d40dSAndrew Rist  * under the License.
19ef39d40dSAndrew Rist  *
20ef39d40dSAndrew Rist  *************************************************************/
21ef39d40dSAndrew Rist 
22ef39d40dSAndrew Rist 
23cdf0e10cSrcweir 
24cdf0e10cSrcweir package lib;
25cdf0e10cSrcweir 
26cdf0e10cSrcweir /**
27cdf0e10cSrcweir  * StatusException is used to pass a Status object from a test code which is
28*e9faf1d9Smseidel  * terminated abnormally. In many cases this is because of an exception thrown,
29cdf0e10cSrcweir  * but that can also be any other event that hinders the test execution.
30cdf0e10cSrcweir  */
31cdf0e10cSrcweir public class StatusException extends RuntimeException {
32cdf0e10cSrcweir     /**
33cdf0e10cSrcweir      * Contains an exception if the StatusException was created with
34cdf0e10cSrcweir      * StatusException(String, Throwable) constructor.
35cdf0e10cSrcweir      */
36cdf0e10cSrcweir     protected Throwable exceptionThrown;
37cdf0e10cSrcweir 
38cdf0e10cSrcweir     /**
39cdf0e10cSrcweir      * The Status contained in the StatusException.
40cdf0e10cSrcweir      */
41cdf0e10cSrcweir     protected Status status;
42cdf0e10cSrcweir 
43cdf0e10cSrcweir     /**
44cdf0e10cSrcweir      * Constructs a StatusException containing an exception Status.
45cdf0e10cSrcweir      *
46cdf0e10cSrcweir      * @param message the message of the StatusException
47cdf0e10cSrcweir      * @param t the exception of the exception Status
48cdf0e10cSrcweir      */
StatusException( String message, Throwable t )49cdf0e10cSrcweir     public StatusException( String message, Throwable t ) {
50cdf0e10cSrcweir         super( message );
51cdf0e10cSrcweir         exceptionThrown = t;
52cdf0e10cSrcweir         status = Status.exception( t );
53cdf0e10cSrcweir     }
54cdf0e10cSrcweir 
55cdf0e10cSrcweir     /**
56cdf0e10cSrcweir      * Creates a StatusException containing a Status.
57cdf0e10cSrcweir      */
StatusException( Status st )58cdf0e10cSrcweir     public StatusException( Status st ) {
59cdf0e10cSrcweir         super( st.getRunStateString() );
60cdf0e10cSrcweir         status = st;
61cdf0e10cSrcweir     }
62cdf0e10cSrcweir 
63cdf0e10cSrcweir     /**
64cdf0e10cSrcweir      * @return an exception, if this represents an exception Status,
65cdf0e10cSrcweir      * <tt>false</tt> otherwise.
66cdf0e10cSrcweir      */
getThrownException()67cdf0e10cSrcweir     public Throwable getThrownException() {
68cdf0e10cSrcweir         return exceptionThrown;
69cdf0e10cSrcweir     }
70cdf0e10cSrcweir 
71cdf0e10cSrcweir     /**
72cdf0e10cSrcweir      * @return a status contained in the StatusException.
73cdf0e10cSrcweir      */
getStatus()74cdf0e10cSrcweir     public Status getStatus() {
75cdf0e10cSrcweir         return status;
76cdf0e10cSrcweir     }
77cdf0e10cSrcweir }