/* LocationOnlyFilter.java -- filter on location
   Copyright (C) 2005, 2006 Free Software Foundation

This file is part of GNU Classpath.

GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.

GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING.  If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301 USA.

Linking this library statically or dynamically with other modules is
making a combined work based on this library.  Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.

As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under
terms of your choice, provided that you also meet, for each linked
terms of your choice, provided that you also meet, for each linked
independent module, the terms and conditions of the license of that
module.  An independent module is a module which is not derived from
or based on this library.  If you modify this library, you may extend
this exception to your version of the library, but you are not
obligated to do so.  If you do not wish to do so, delete this
exception statement from your version. */


package gnu.classpath.jdwp.event.filters;

import gnu.classpath.jdwp.event.Event;
import gnu.classpath.jdwp.exception.InvalidLocationException;
import gnu.classpath.jdwp.util.Location;

/**
 * Restricts reported events to those that occur at the given location.
 *
 * May be used with breakpoint, field access, field modification, step,
 * and exception event kinds.
 *
 * This "filter" is not really a filter. It is simply a way to communicate
 * location information for supported events in a generic way to ease 
 * the burden of special casing several things in
 * EventReqeustCommandSet.executeSet.
 * 
 * Consequently, this "filter" always matches any event.
 * 
 * @author Keith Seitz  (keiths@redhat.com)
 */
public class LocationOnlyFilter
  implements IEventFilter
{
  private Location _location;

  /**
   * Constructs a new <code>LocationOnlyFilter</code>.
   *
   * @param  loc  the location for which to report events
   * @throws InvalidLocationException if location is invalid
   */
  public LocationOnlyFilter (Location loc)
    throws InvalidLocationException
  {
    _location = loc;
  }

  /**
   * Returns the location at which to restrict events
   *
   * @return the location
   */
  public Location getLocation ()
  {
    return _location;
  }

  /**
   * Does the given event match the filter?
   *
   * @param event  the <code>Event</code> to scrutinize
   */
  public boolean matches (Event event)
  {
    // This filter always matches. See comments in class javadoc.
    return true;
  }
}
