Source for gnu.CORBA.Unexpected

   1: /* DNW.java --
   2:    Copyright (C) 2005 Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: 
  39: package gnu.CORBA;
  40: 
  41: 
  42: /**
  43:  * Contains the static method to throw an error in the case
  44:  * when the execution should never get into the current point.
  45:  *
  46:  * The error message contains the text, suggesting to check
  47:  * the user code first and then report a bug.
  48:  *
  49:  * @author Audrius Meskauskas (AudriusA@Bioinformatics.org)
  50:  */
  51: public class Unexpected
  52:   extends InternalError
  53: {
  54:   /**
  55:    * Use serialVersionUID for interoperability.
  56:    */
  57:   private static final long serialVersionUID = 1;
  58: 
  59:   /**
  60:    * The default message for the CORBA assertion error.
  61:    */
  62:   public static final String SHARED_MESSAGE =
  63:     "CORBA assertion error. Please check your code. " +
  64:     "If you think it is Classpath problem, please report " +
  65:     "this bug providing as much information as possible.";
  66: 
  67:   /**
  68:    * Create an instance with explaining message and enclosing
  69:    * exception.
  70:    */
  71:   public Unexpected(String msg, Exception why)
  72:   {
  73:     super(msg + ". " + SHARED_MESSAGE);
  74:     if (why != null)
  75:       initCause(why);
  76:   }
  77: 
  78:   /**
  79:    * Create an instance with enclosing exception.
  80:    */
  81:   public Unexpected(Exception why)
  82:   {
  83:     super(SHARED_MESSAGE);
  84:     if (why != null)
  85:       initCause(why);
  86:   }
  87: 
  88:   /**
  89:    * Create an instance.
  90:    */
  91:   public Unexpected()
  92:   {
  93:     super(SHARED_MESSAGE);
  94:   }
  95: 
  96:   /**
  97:    * Throws an error with the custom explaining message and
  98:    * the appended share message.
  99:    *
 100:    * @param msg the error message
 101:    * @param why the enclosing exception.
 102:    */
 103:   public static void error(String msg, Exception why)
 104:   {
 105:     throw new Unexpected(msg, why);
 106:   }
 107: 
 108:   /**
 109:    * Throws an error with the shared explaining message.
 110:    *
 111:    * @param why the enclosing exception.
 112:    * @throws Error, always.
 113:    */
 114:   public static void error(Exception why)
 115:   {
 116:     throw new Unexpected(why);
 117:   }
 118: 
 119:   /**
 120:    * Throws an error with the shared explaining message.
 121:    *
 122:    * @throws Error, always.
 123:    */
 124:   public static void error()
 125:   {
 126:     throw new Unexpected();
 127:   }
 128: }