Source for gnu.classpath.jdwp.event.MethodExitEvent

   1: /* MethodExitEvent.java -- an event specifying that a method has returned
   2:  Copyright (C) 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 gnu.classpath.jdwp.event;
  40: 
  41: import gnu.classpath.jdwp.JdwpConstants;
  42: import gnu.classpath.jdwp.VMIdManager;
  43: import gnu.classpath.jdwp.id.ThreadId;
  44: import gnu.classpath.jdwp.util.Location;
  45: 
  46: import java.io.DataOutputStream;
  47: import java.io.IOException;
  48: 
  49: /**
  50:  * Notification from the VM that that a method has returned
  51:  *
  52:  * @author Kyle Galloway (kgallowa@redhat.com)
  53:  */
  54: public class MethodExitEvent
  55:     extends Event
  56: {
  57:   // The thread where the event occurred
  58:   private Thread _thread;
  59: 
  60:   // the location where the event occurred
  61:   private Location _location;
  62: 
  63:   // object instance
  64:   private Object _instance;
  65: 
  66:   /**
  67:    * Constructs a new <code>MethodExitEvent</code>
  68:    *
  69:    * @param thread the thread where the exception occurred
  70:    * @param location the location single stepped to
  71:    * @param instance the instance from which the method was called
  72:    */
  73:   public MethodExitEvent(Thread thread, Location location, Object instance)
  74:   {
  75:     super(JdwpConstants.EventKind.METHOD_EXIT);
  76:     _thread = thread;
  77:     _location = location;
  78:     _instance = instance;
  79:   }
  80: 
  81:   /**
  82:    * Returns a specific filtering parameter for this event. Valid types are
  83:    * thread and location
  84:    *
  85:    * @param type the type of parameter desired
  86:    * @returns the desired parameter or null
  87:    */
  88:   public Object getParameter(int type)
  89:   {
  90:     if (type == EVENT_THREAD)
  91:       return _thread;
  92:     else if (type == EVENT_LOCATION)
  93:       return _location;
  94:     else if (type == EVENT_CLASS)
  95:       return _instance.getClass();
  96: 
  97:     return null;
  98:   }
  99: 
 100:   /**
 101:    * Writes the event to the given stream
 102:    *
 103:    * @param outStream the output stream to write the event to
 104:    * @throws IOException
 105:    */
 106:   protected void _writeData(DataOutputStream outStream)
 107:     throws IOException
 108:   {
 109:     VMIdManager idm = VMIdManager.getDefault();
 110:     ThreadId tid = (ThreadId) idm.getObjectId(_thread);
 111: 
 112:     tid.write(outStream);
 113:     _location.write(outStream);
 114:   }
 115: }