1 /*
   2  * Copyright (c) 2007, 2017 Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.
   8  *
   9  * This code is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12  * version 2 for more details (a copy is included in the LICENSE file that
  13  * accompanied this code).
  14  *
  15  * You should have received a copy of the GNU General Public License version
  16  * 2 along with this work; if not, write to the Free Software Foundation,
  17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  18  *
  19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  20  * or visit www.oracle.com if you need additional information or have any
  21  * questions.
  22  */
  23 package org.jemmy;
  24 
  25 
  26 /**
  27  *
  28  * Parent of all Jemmy exceptions.
  29  * Exception can be thrown from inside jemmy methods,
  30  * if some exception occurs from code invoked from jemmy.
  31  *
  32  * @author Alexandre Iline (alexandre.iline@oracle.com), Alexander Kouznetsov (Alexander.Kouznetsov@oracle.com)
  33  */
  34 
  35 public class JemmyException extends RuntimeException {
  36 
  37     private Object object = null;
  38 
  39     /**
  40      * Constructor.
  41      * @param description An exception description.
  42      */
  43     public JemmyException(String description) {
  44         super(description);
  45     }
  46 
  47     /**
  48      * Constructor.
  49      * @param description An exception description.
  50      * @param innerException Exception from code invoked from jemmy.
  51      */
  52     public JemmyException(String description, Throwable innerException) {
  53         super(description, innerException);
  54     }
  55 
  56     /**
  57      * Constructor.
  58      * @param description An exception description.
  59      * @param object Object regarding which exception is thrown.
  60      */
  61     public JemmyException(String description, Object object) {
  62         this(description, null, object);
  63     }
  64 
  65     /**
  66      * Constructor.
  67      * @param description An exception description.
  68      * @param innerException Exception from code invoked from jemmy.
  69      * @param object Object regarding which exception is thrown.
  70      */
  71     public JemmyException(String description, Throwable innerException, Object object) {
  72         this(description + " (Object: " + object + ")", innerException);
  73         this.object = object;
  74     }
  75 
  76     /**
  77      * Returns "object" constructor parameter.
  78      * @return the Object value associated with the exception.
  79      */
  80     public Object getObject() {
  81         return(object);
  82     }
  83 }