Source for gnu.classpath.jdwp.event.filters.StepFilter

   1: /* StepFilter.java -- a step filter
   2:    Copyright (C) 2005, 2007 Free Software Foundation
   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: terms of your choice, provided that you also meet, for each linked
  32: independent module, the terms and conditions of the license of that
  33: module.  An independent module is a module which is not derived from
  34: or based on this library.  If you modify this library, you may extend
  35: this exception to your version of the library, but you are not
  36: obligated to do so.  If you do not wish to do so, delete this
  37: exception statement from your version. */
  38: 
  39: 
  40: package gnu.classpath.jdwp.event.filters;
  41: 
  42: import gnu.classpath.jdwp.JdwpConstants;
  43: import gnu.classpath.jdwp.event.Event;
  44: import gnu.classpath.jdwp.exception.InvalidThreadException;
  45: import gnu.classpath.jdwp.id.ThreadId;
  46: 
  47: /**
  48:  * "An event filter which restricts reported step events to those which
  49:  * satisfy depth and size constraints. This modifier can only be used with
  50:  * step event kinds."
  51:  *
  52:  * This "filter" is not really a filter. It is simply a way to communicate
  53:  * stepping information in a convenient way between the JDWP backend and
  54:  * the virtual machine.
  55:  * 
  56:  * Consequently, this "filter" always matches.
  57:  * 
  58:  * @author Keith Seitz  (keiths@redhat.com)
  59:  */
  60: public class StepFilter
  61:   implements IEventFilter
  62: {
  63:   private ThreadId _tid;
  64:   private int _size;
  65:   private int _depth;
  66: 
  67:   /**
  68:    * Constructs a new StepFilter
  69:    *
  70:    * @param tid    ID of the thread in which to step
  71:    * @param size   size of each step
  72:    * @param depth  relative call stack limit
  73:    * @throws InvalidThreadException if thread is invalid
  74:    */
  75:   public StepFilter (ThreadId tid, int size, int depth)
  76:     throws InvalidThreadException
  77:   {
  78:     if (tid.getReference().get () == null)
  79:       throw new InvalidThreadException (tid.getId ());
  80: 
  81:     _tid = tid;
  82:     _size = size;
  83:     _depth = depth;
  84:   }
  85: 
  86:   /**
  87:    * Returns the thread in which to step
  88:    *
  89:    * @return the thread's ID
  90:    */
  91:   public ThreadId getThread ()
  92:   {
  93:     return _tid;
  94:   }
  95: 
  96:   /**
  97:    * Returns the size of each step (insn, line)
  98:    *
  99:    * @return the step size
 100:    * @see gnu.classpath.jdwp.JdwpConstants.StepSize
 101:    */
 102:   public int getSize ()
 103:   {
 104:     return _size;
 105:   }
 106: 
 107:   /**
 108:    * Returns the relative call stack limit (into, over, out)
 109:    *
 110:    * @return how to step
 111:    * @see gnu.classpath.jdwp.JdwpConstants.StepDepth
 112:    */
 113:   public int getDepth ()
 114:   {
 115:     return _depth;
 116:   }
 117: 
 118:   /**
 119:    * Does the given event match the filter?
 120:    *
 121:    * @param event  the <code>Event</code> to scrutinize
 122:    */
 123:   public boolean matches (Event event)
 124:   {
 125:     return true;
 126:   }
 127: }