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

   1: /* LocationOnlyFilter.java -- filter on location
   2:    Copyright (C) 2005, 2006, 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.event.Event;
  43: import gnu.classpath.jdwp.exception.InvalidLocationException;
  44: import gnu.classpath.jdwp.util.Location;
  45: 
  46: /**
  47:  * Restricts reported events to those that occur at the given location.
  48:  *
  49:  * May be used with breakpoint, field access, field modification, step,
  50:  * and exception event kinds.
  51:  *
  52:  * @author Keith Seitz  (keiths@redhat.com)
  53:  */
  54: public class LocationOnlyFilter
  55:   implements IEventFilter
  56: {
  57:   private Location _location;
  58: 
  59:   /**
  60:    * Constructs a new <code>LocationOnlyFilter</code>.
  61:    *
  62:    * @param  loc  the location for which to report events
  63:    * @throws InvalidLocationException if location is invalid
  64:    */
  65:   public LocationOnlyFilter (Location loc)
  66:     throws InvalidLocationException
  67:   {
  68:     _location = loc;
  69:   }
  70: 
  71:   /**
  72:    * Returns the location at which to restrict events
  73:    *
  74:    * @return the location
  75:    */
  76:   public Location getLocation ()
  77:   {
  78:     return _location;
  79:   }
  80: 
  81:   /**
  82:    * Does the given event match the filter?
  83:    *
  84:    * @param event  the <code>Event</code> to scrutinize
  85:    */
  86:   public boolean matches(Event event)
  87:   {
  88:     Location loc = (Location) event.getParameter(Event.EVENT_LOCATION);
  89:     if (loc != null)
  90:       return (getLocation().equals(loc));
  91: 
  92:     return false;
  93:   }
  94: }