001/* SystemException.java --
002 Copyright (C) 2005, 2006 Free Software Foundation, Inc.
003
004 This file is part of GNU Classpath.
005
006 GNU Classpath is free software; you can redistribute it and/or modify
007 it under the terms of the GNU General Public License as published by
008 the Free Software Foundation; either version 2, or (at your option)
009 any later version.
010
011 GNU Classpath is distributed in the hope that it will be useful, but
012 WITHOUT ANY WARRANTY; without even the implied warranty of
013 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014 General Public License for more details.
015
016 You should have received a copy of the GNU General Public License
017 along with GNU Classpath; see the file COPYING.  If not, write to the
018 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
019 02110-1301 USA.
020
021 Linking this library statically or dynamically with other modules is
022 making a combined work based on this library.  Thus, the terms and
023 conditions of the GNU General Public License cover the whole
024 combination.
025
026 As a special exception, the copyright holders of this library give you
027 permission to link this library with independent modules to produce an
028 executable, regardless of the license terms of these independent
029 modules, and to copy and distribute the resulting executable under
030 terms of your choice, provided that you also meet, for each linked
031 independent module, the terms and conditions of the license of that
032 module.  An independent module is a module which is not derived from
033 or based on this library.  If you modify this library, you may extend
034 this exception to your version of the library, but you are not
035 obligated to do so.  If you do not wish to do so, delete this
036 exception statement from your version. */
037
038
039package org.omg.CORBA;
040
041import java.io.Serializable;
042
043/**
044 * The root class for all CORBA standard exceptions.
045 *
046 * @author Audrius Meskauskas (AudriusA@Bioinformatics.org)
047 */
048public abstract class SystemException
049  extends RuntimeException
050  implements Serializable
051{
052  /**
053   * Use serialVersionUID for interoperability. Using the version 1.4 UID.
054   */
055  private static final long serialVersionUID = -8486391734674855519L;
056
057  /**
058   * The status of the operation that have thrown this exception.
059   */
060  public CompletionStatus completed;
061
062  /**
063   * <p>
064   * Contains more details about the exception. The lower 12 bits contain a
065   * code, defining the reason why exception has been thrown. The higher 20 bits
066   * hold "Vendor Minor Codeset ID" (VMCID).
067   * </p>
068   * <p>
069   * The Classpath specifice minor exception codes are documented in the headers
070   * of the corresponding exceptions (for instance, {@link MARSHAL}).
071   * </p>
072   *
073   * The VMCID 0 and 0xfffff are reserved for experimental use.
074   *
075   * @see OMGVMCID
076   */
077  public int minor;
078
079  /**
080   * Constructs an instance of the CORBA standard exception.
081   *
082   * @param a_reason a string, explaining the reason why the exceptions has been
083   * thrown.
084   * @param a_minor an additional error code (known as the "minor")
085   * @param a_completed the task completion status.
086   */
087  protected SystemException(String a_reason, int a_minor,
088                            CompletionStatus a_completed)
089  {
090    super(a_reason + " Minor: " + Integer.toHexString(a_minor) + " ("
091      + (a_minor & 0xFFF) + "). Completed: "+a_completed);
092    minor = a_minor;
093    completed = a_completed;
094  }
095}