Source for java.util.logging.Filter

   1: /* Filter.java -- an interface for filters that decide whether a
   2:    LogRecord should be published or discarded
   3:    Copyright (C) 2002, 2004 Free Software Foundation, Inc.
   4: 
   5: This file is part of GNU Classpath.
   6: 
   7: GNU Classpath is free software; you can redistribute it and/or modify
   8: it under the terms of the GNU General Public License as published by
   9: the Free Software Foundation; either version 2, or (at your option)
  10: any later version.
  11: 
  12: GNU Classpath is distributed in the hope that it will be useful, but
  13: WITHOUT ANY WARRANTY; without even the implied warranty of
  14: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15: General Public License for more details.
  16: 
  17: You should have received a copy of the GNU General Public License
  18: along with GNU Classpath; see the file COPYING.  If not, write to the
  19: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  20: 02110-1301 USA.
  21: 
  22: Linking this library statically or dynamically with other modules is
  23: making a combined work based on this library.  Thus, the terms and
  24: conditions of the GNU General Public License cover the whole
  25: combination.
  26: 
  27: As a special exception, the copyright holders of this library give you
  28: permission to link this library with independent modules to produce an
  29: executable, regardless of the license terms of these independent
  30: modules, and to copy and distribute the resulting executable under
  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 java.util.logging;
  41: 
  42: /**
  43:  * By implementing the <code>Filter</code> interface, applications
  44:  * can control what is being logged based on arbitrary properties,
  45:  * not just the severity level.  Both <code>Handler</code> and
  46:  * <code>Logger</code> allow to register Filters whose
  47:  * <code>isLoggable</code> method will be called when a
  48:  * <code>LogRecord</code> has passed the test based on the
  49:  * severity level.
  50:  *
  51:  * @author Sascha Brawer (brawer@acm.org)
  52:  */
  53: public interface Filter
  54: {
  55:   /**
  56:    * Determines whether a LogRecord should be published or discarded.
  57:    *
  58:    * @param record the <code>LogRecord</code> to be inspected.
  59:    *
  60:    * @return <code>true</code> if the record should be published,
  61:    *         <code>false</code> if it should be discarded.
  62:    */
  63:   boolean isLoggable(LogRecord record);
  64: }