KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > log > filter > PriorityFilter


1 /* ====================================================================
2  * The Apache Software License, Version 1.1
3  *
4  * Copyright (c) 1997-2003 The Apache Software Foundation. All rights
5  * reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * 1. Redistributions of source code must retain the above copyright
12  * notice, this list of conditions and the following disclaimer.
13  *
14  * 2. Redistributions in binary form must reproduce the above copyright
15  * notice, this list of conditions and the following disclaimer in
16  * the documentation and/or other materials provided with the
17  * distribution.
18  *
19  * 3. The end-user documentation included with the redistribution,
20  * if any, must include the following acknowledgment:
21  * "This product includes software developed by the
22  * Apache Software Foundation (http://www.apache.org/)."
23  * Alternately, this acknowledgment may appear in the software
24  * itself, if and wherever such third-party acknowledgments
25  * normally appear.
26  *
27  * 4. The names "Jakarta", "Avalon", and "Apache Software Foundation"
28  * must not be used to endorse or promote products derived from this
29  * software without prior written permission. For written
30  * permission, please contact apache@apache.org.
31  *
32  * 5. Products derived from this software may not be called "Apache",
33  * nor may "Apache" appear in their name, without prior written
34  * permission of the Apache Software Foundation.
35  *
36  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39  * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
40  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
42  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
43  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
44  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
45  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
46  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
47  * SUCH DAMAGE.
48  * ====================================================================
49  *
50  * This software consists of voluntary contributions made by many
51  * individuals on behalf of the Apache Software Foundation. For more
52  * information on the Apache Software Foundation, please see
53  * <http://www.apache.org/>.
54  */
55 package org.apache.log.filter;
56
57 import org.apache.log.LogEvent;
58 import org.apache.log.Priority;
59
60 /**
61  * Filters log events based on priority.
62  *
63  * @author <a HREF="mailto:peter@apache.org">Peter Donald</a>
64  */
65 public class PriorityFilter
66     extends AbstractFilterTarget
67 {
68     ///Priority to filter against
69 private Priority m_priority;
70
71     /**
72      * Constructor that sets the priority that is filtered against.
73      *
74      * @param priority the Priority
75      */
76     public PriorityFilter( final Priority priority )
77     {
78         m_priority = priority;
79     }
80
81     /**
82      * Set priority used to filter.
83      *
84      * @param priority the priority to filter on
85      */
86     public void setPriority( final Priority priority )
87     {
88         m_priority = priority;
89     }
90
91     /**
92      * Filter the log event based on priority.
93      *
94      * If LogEvent has a Lower or Equal priroity then discard it.
95      *
96      * @param event the event
97      * @return return true to discard event, false otherwise
98      */
99     protected boolean filter( final LogEvent event )
100     {
101         return ( m_priority.isGreater( event.getPriority() ) );
102     }
103 }
104
Popular Tags