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