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 */
017
018package org.apache.logging.log4j.core.appender.rolling;
019
020import org.apache.logging.log4j.core.Core;
021import org.apache.logging.log4j.core.LogEvent;
022import org.apache.logging.log4j.core.config.plugins.Plugin;
023import org.apache.logging.log4j.core.config.plugins.PluginFactory;
024
025/*
026 * Never triggers and is handy for edge-cases in tests for example.
027 *
028 * @since 2.11.1
029 */
030@Plugin(name = "NoOpTriggeringPolicy", category = Core.CATEGORY_NAME, printObject = true)
031public class NoOpTriggeringPolicy extends AbstractTriggeringPolicy {
032
033        public static final NoOpTriggeringPolicy INSTANCE = new NoOpTriggeringPolicy();
034
035        @PluginFactory
036        public static NoOpTriggeringPolicy createPolicy() {
037                return INSTANCE;
038        }
039
040        @Override
041        public void initialize(final RollingFileManager manager) {
042                // NoOp
043        }
044
045        @Override
046        public boolean isTriggeringEvent(final LogEvent logEvent) {
047                // Never triggers.
048                return false;
049        }
050
051}