src/lib/vm/reference/java/lang/VMThrowable.java

   1 /* java.lang.VMThrowable -- VM support methods for Throwable.
   2    Copyright (C) 1998, 1999, 2002 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 package java.lang;
  39
  40 import gnu.classpath.Pointer;
  41
  42 /**
  43  * VM dependant state and support methods for Throwable.
  44  * It is deliberately package local and final and should only be accessed
  45  * by the Throwable class.
  46  * <p>
  47  * This is the GNU Classpath reference implementation, it should be adapted
  48  * for a specific VM. The reference implementation does nothing.
  49  *
  50  * @author Mark Wielaard (mark@klomp.org)
  51  */
  52 final class VMThrowable
  53 {
  54   /* IMPORTANT: the rawdata field is not a java object */
  55   private final Pointer vmData;
  56
  57   /**
  58    * VM private data.
  59    */
  60   private transient Object vmdata;
  61
  62   /**
  63    * Private contructor, create VMThrowables with fillInStackTrace();
  64    */
  65 //    private VMThrowable() { }
  66   private VMThrowable()
  67   {
  68     vmData = null;
  69   }
  70
  71   /**
  72    * Fill in the stack trace with the current execution stack.
  73    * Called by <code>Throwable.fillInStackTrace()</code> to get the state of
  74    * the VM. Can return null when the VM does not support caputing the VM
  75    * execution state.
  76    *
  77    * @return a new VMThrowable containing the current execution stack trace.
  78    * @see Throwable#fillInStackTrace()
  79    */
  80   static native VMThrowable fillInStackTrace(Throwable t);
  81
  82   /**
  83    * Returns an <code>StackTraceElement</code> array based on the execution
  84    * state of the VM as captured by <code>fillInStackTrace</code>.
  85    * Called by <code>Throwable.getStackTrace()</code>.
  86    *
  87    * @return a non-null but possible zero length array of StackTraceElement.
  88    * @see Throwable#getStackTrace()
  89    */
  90   native StackTraceElement[] getStackTrace(Throwable t);
  91 }