View Javadoc
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  package org.apache.logging.log4j.core.appender;
18  
19  import org.apache.logging.log4j.core.Appender;
20  import org.apache.logging.log4j.core.Core;
21  import org.apache.logging.log4j.core.LogEvent;
22  import org.apache.logging.log4j.core.config.Property;
23  import org.apache.logging.log4j.core.config.plugins.Plugin;
24  import org.apache.logging.log4j.core.config.plugins.PluginAttribute;
25  import org.apache.logging.log4j.core.config.plugins.PluginFactory;
26  
27  /**
28   * An Appender that ignores log events. Use for compatibility with version 1.2
29   * and handy for composing a {@link ScriptAppenderSelector}.
30   */
31  @Plugin(name = NullAppender.PLUGIN_NAME, category = Core.CATEGORY_NAME, elementType = Appender.ELEMENT_TYPE, printObject = true)
32  public class NullAppender extends AbstractAppender {
33  
34  	public static final String PLUGIN_NAME = "Null";
35  
36  	@PluginFactory
37  	public static NullAppender createAppender(
38  			@PluginAttribute(value = "name", defaultString = "null") final String name) {
39  		return new NullAppender(name);
40  	}
41  
42  	private NullAppender(final String name) {
43  		super(name, null, null, true, Property.EMPTY_ARRAY);
44  	}
45  
46  	@Override
47  	public void append(final LogEvent event) {
48  		// Do nothing
49  	}
50  
51  }