1 /*************************************************************************
2  *
3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4  *
5  * Copyright 2000, 2010 Oracle and/or its affiliates.
6  *
7  * OpenOffice.org - a multi-platform office productivity suite
8  *
9  * This file is part of OpenOffice.org.
10  *
11  * OpenOffice.org is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU Lesser General Public License version 3
13  * only, as published by the Free Software Foundation.
14  *
15  * OpenOffice.org is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU Lesser General Public License version 3 for more details
19  * (a copy is included in the LICENSE file that accompanied this code).
20  *
21  * You should have received a copy of the GNU Lesser General Public License
22  * version 3 along with OpenOffice.org.  If not, see
23  * <http://www.openoffice.org/license.html>
24  * for a copy of the LGPLv3 License.
25  *
26  ************************************************************************/
27 
28 package lib;
29 
30 /**
31  * StatusException is used to pass a Status object from a test code which is
32  * terminated abnormaly. In many cases this is because of an exception thrown,
33  * but that can also be any other event that hinders the test execution.
34  */
35 public class StatusException extends RuntimeException {
36     /**
37      * Contains an exception if the StatusException was created with
38      * StatusException(String, Throwable) constructor.
39      */
40     protected Throwable exceptionThrown;
41 
42     /**
43      * The Status contained in the StatusException.
44      */
45     protected Status status;
46 
47     /**
48      * Constructs a StatusException containing an exception Status.
49      *
50      * @param message the message of the StatusException
51      * @param t the exception of the exception Status
52      */
53     public StatusException( String message, Throwable t ) {
54         super( message );
55         exceptionThrown = t;
56         status = Status.exception( t );
57     }
58 
59     /**
60      * Creates a StatusException containing a Status.
61      */
62     public StatusException( Status st ) {
63         super( st.getRunStateString() );
64         status = st;
65     }
66 
67     /**
68      * @return an exception, if this represents an exception Status,
69      * <tt>false</tt> otherwise.
70      */
71     public Throwable getThrownException() {
72         return exceptionThrown;
73     }
74 
75     /**
76      * @return a status contained in the StatusException.
77      */
78     public Status getStatus() {
79         return status;
80     }
81 }