001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 * 
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 * 
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017
018package org.apache.log4j.spi;
019
020/**
021   
022   Implementions of this interface allow certain appenders to decide
023   when to perform an appender specific action.
024
025  <p>For example the {@link org.apache.log4j.net.SMTPAppender} sends
026  an email when the {@link #isTriggeringEvent} method returns
027  <code>true</code> and adds the event to an internal buffer when the
028  returned result is <code>false</code>.
029
030  @author Ceki G&uuml;lc&uuml;
031  @since version 1.0
032   
033 */
034public interface TriggeringEventEvaluator {
035  
036  /**
037     Is this the triggering event?
038   */
039  public boolean isTriggeringEvent(LoggingEvent event);
040}