qadevOOo/runner/lib/StatusException.java

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