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.rolling.action;
18  
19  import java.nio.file.Path;
20  import java.nio.file.attribute.BasicFileAttributes;
21  import java.util.Arrays;
22  import java.util.Objects;
23  
24  import org.apache.logging.log4j.core.config.plugins.Plugin;
25  import org.apache.logging.log4j.core.config.plugins.PluginElement;
26  import org.apache.logging.log4j.core.config.plugins.PluginFactory;
27  
28  /**
29   * Composite {@code PathCondition} that accepts objects that are accepted by <em>any</em> component conditions.
30   * Corresponds to logical "OR".
31   */
32  @Plugin(name = "IfAny", category = "Core", printObject = true)
33  public final class IfAny implements PathCondition {
34  
35      private final PathCondition[] components;
36  
37      private IfAny(final PathCondition... filters) {
38          this.components = Objects.requireNonNull(filters, "filters");
39      }
40  
41      public PathCondition[] getDeleteFilters() {
42          return components;
43      }
44  
45      /*
46       * (non-Javadoc)
47       * @see org.apache.logging.log4j.core.appender.rolling.action.PathCondition#accept(java.nio.file.Path, java.nio.file.Path, java.nio.file.attribute.BasicFileAttributes)
48       */
49      @Override
50      public boolean accept(final Path baseDir, final Path relativePath, final BasicFileAttributes attrs) {
51          for (final PathCondition component : components) {
52              if (component.accept(baseDir, relativePath, attrs)) {
53                  return true;
54              }
55          }
56          return false;
57      }
58  
59      /*
60       * (non-Javadoc)
61       * @see org.apache.logging.log4j.core.appender.rolling.action.PathCondition#beforeFileTreeWalk()
62       */
63      @Override
64      public void beforeFileTreeWalk() {
65          for (final PathCondition condition : components) {
66              condition.beforeFileTreeWalk();
67          }
68      }
69  
70      /**
71       * Create a Composite PathCondition: accepts if any of the nested conditions accepts.
72       * 
73       * @param components The component conditions.
74       * @return A Composite PathCondition.
75       */
76      @PluginFactory
77      public static IfAny createOrCondition( //
78              @PluginElement("PathConditions") final PathCondition... components) {
79          return new IfAny(components);
80      }
81  
82      @Override
83      public String toString() {
84          return "IfAny" + Arrays.toString(components);
85      }
86  }