libjava/classpath/org/omg/CORBA/SystemException.java

   1 /* SystemException.java --
   2  Copyright (C) 2005, 2006 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 org.omg.CORBA;
  40
  41 import java.io.Serializable;
  42
  43 /**
  44  * The root class for all CORBA standard exceptions.
  45  *
  46  * @author Audrius Meskauskas (AudriusA@Bioinformatics.org)
  47  */
  48 public abstract class SystemException
  49   extends RuntimeException
  50   implements Serializable
  51 {
  52   /**
  53    * Use serialVersionUID for interoperability. Using the version 1.4 UID.
  54    */
  55   private static final long serialVersionUID = -8486391734674855519L;
  56
  57   /**
  58    * The status of the operation that have thrown this exception.
  59    */
  60   public CompletionStatus completed;
  61
  62   /**
  63    * <p>
  64    * Contains more details about the exception. The lower 12 bits contain a
  65    * code, defining the reason why exception has been thrown. The higher 20 bits
  66    * hold "Vendor Minor Codeset ID" (VMCID).
  67    * </p>
  68    * <p>
  69    * The Classpath specifice minor exception codes are documented in the headers
  70    * of the corresponding exceptions (for instance, {@link MARSHAL}).
  71    * </p>
  72    *
  73    * The VMCID 0 and 0xfffff are reserved for experimental use.
  74    *
  75    * @see OMGVMCID
  76    */
  77   public int minor;
  78
  79   /**
  80    * Constructs an instance of the CORBA standard exception.
  81    *
  82    * @param a_reason a string, explaining the reason why the exceptions has been
  83    * thrown.
  84    * @param a_minor an additional error code (known as the "minor")
  85    * @param a_completed the task completion status.
  86    */
  87   protected SystemException(String a_reason, int a_minor,
  88                             CompletionStatus a_completed)
  89   {
  90     super(a_reason + " Minor: " + Integer.toHexString(a_minor) + " ("
  91       + (a_minor & 0xFFF) + "). Completed: "+a_completed);
  92     minor = a_minor;
  93     completed = a_completed;
  94   }
  95 }