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.varia;
19
20 import org.apache.log4j.spi.Filter;
21 import org.apache.log4j.spi.LoggingEvent;
22
23
24 /**
25 This filter drops all logging events.
26
27 <p>You can add this filter to the end of a filter chain to
28 switch from the default "accept all unless instructed otherwise"
29 filtering behaviour to a "deny all unless instructed otherwise"
30 behaviour.
31
32
33 @author Ceki Gülcü
34
35 @since 0.9.0 */
36 public class DenyAllFilter extends Filter {
37
38 /**
39 Returns <code>null</code> as there are no options.
40
41 @deprecated We now use JavaBeans introspection to configure
42 components. Options strings are no longer needed.
43 */
44 public
45 String[] getOptionStrings() {
46 return null;
47 }
48
49
50 /**
51 No options to set.
52
53 @deprecated Use the setter method for the option directly instead
54 of the generic <code>setOption</code> method.
55 */
56 public
57 void setOption(String key, String value) {
58 }
59
60 /**
61 Always returns the integer constant {@link Filter#DENY}
62 regardless of the {@link LoggingEvent} parameter.
63
64 @param event The LoggingEvent to filter.
65 @return Always returns {@link Filter#DENY}.
66 */
67 public
68 int decide(LoggingEvent event) {
69 return Filter.DENY;
70 }
71 }
72