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 */
017package org.apache.logging.log4j.core.appender;
018
019import org.apache.logging.log4j.core.Appender;
020import org.apache.logging.log4j.core.Core;
021import org.apache.logging.log4j.core.LogEvent;
022import org.apache.logging.log4j.core.config.Property;
023import org.apache.logging.log4j.core.config.plugins.Plugin;
024import org.apache.logging.log4j.core.config.plugins.PluginAttribute;
025import org.apache.logging.log4j.core.config.plugins.PluginFactory;
026
027/**
028 * An Appender that ignores log events. Use for compatibility with version 1.2
029 * and handy for composing a {@link ScriptAppenderSelector}.
030 */
031@Plugin(name = NullAppender.PLUGIN_NAME, category = Core.CATEGORY_NAME, elementType = Appender.ELEMENT_TYPE, printObject = true)
032public class NullAppender extends AbstractAppender {
033
034        public static final String PLUGIN_NAME = "Null";
035
036        @PluginFactory
037        public static NullAppender createAppender(
038                        @PluginAttribute(value = "name", defaultString = "null") final String name) {
039                return new NullAppender(name);
040        }
041
042        private NullAppender(final String name) {
043                super(name, null, null, true, Property.EMPTY_ARRAY);
044        }
045
046        @Override
047        public void append(final LogEvent event) {
048                // Do nothing
049        }
050
051}