srcjar/org/apache/log4j/spi/TriggeringEventEvaluator.java

   1 /*
   2  * Licensed to the Apache Software Foundation (ASF) under one or more
   3  * contributor license agreements.  See the NOTICE file distributed with
   4  * this work for additional information regarding copyright ownership.
   5  * The ASF licenses this file to You under the Apache License, Version 2.0
   6  * (the "License"); you may not use this file except in compliance with
   7  * the License.  You may obtain a copy of the License at
   8  *
   9  *      http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17
  18 package org.apache.log4j.spi;
  19
  20 /**
  21
  22    Implementions of this interface allow certain appenders to decide
  23    when to perform an appender specific action.
  24
  25   <p>For example the {@link org.apache.log4j.net.SMTPAppender} sends
  26   an email when the {@link #isTriggeringEvent} method returns
  27   <code>true</code> and adds the event to an internal buffer when the
  28   returned result is <code>false</code>.
  29
  30   @author Ceki G&uuml;lc&uuml;
  31   @since version 1.0
  32
  33  */
  34 public interface TriggeringEventEvaluator {
  35
  36   /**
  37      Is this the triggering event?
  38    */
  39   public boolean isTriggeringEvent(LoggingEvent event);
  40 }