KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > log4j > spi > TriggeringEventEvaluator


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