Package org.apache.logging.log4j.core.appender.rolling.action

Class IfAny

  • All Implemented Interfaces:
    PathCondition
    @Plugin(name="IfAny",
        category="Core",
        printObject=true)
public final class IfAny
extends java.lang.Object
implements PathCondition
    Composite PathCondition that accepts objects that are accepted by any component conditions. Corresponds to logical "OR".

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private IfAny​(PathCondition... filters)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean accept​(java.nio.file.Path baseDir, java.nio.file.Path relativePath, java.nio.file.attribute.BasicFileAttributes attrs)
      Returns true if the specified candidate path should be deleted, false otherwise.
      void beforeFileTreeWalk()
      Invoked before a new file tree walk is started.
      static IfAny createOrCondition​(PathCondition... components)
      Create a Composite PathCondition: accepts if any of the nested conditions accepts.
      PathCondition[] getDeleteFilters()  
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Method Detail

      • accept

        public boolean accept​(java.nio.file.Path baseDir,
                      java.nio.file.Path relativePath,
                      java.nio.file.attribute.BasicFileAttributes attrs)
        Description copied from interface: PathCondition
        Returns true if the specified candidate path should be deleted, false otherwise.
        Specified by:
        accept in interface PathCondition
        Parameters:
        baseDir - the directory from where to start scanning for deletion candidate files
        relativePath - the candidate for deletion. This path is relative to the baseDir.
        attrs - attributes of the candidate path
        Returns:
        whether the candidate path should be deleted

      • beforeFileTreeWalk

        public void beforeFileTreeWalk()
        Description copied from interface: PathCondition
        Invoked before a new file tree walk is started. Stateful PathConditions can reset their state when this method is called.
        Specified by:
        beforeFileTreeWalk in interface PathCondition

      • createOrCondition

        @PluginFactory
public static IfAny createOrCondition​(@PluginElement("PathConditions")
                                      PathCondition... components)
        Create a Composite PathCondition: accepts if any of the nested conditions accepts.
        Parameters:
        components - The component conditions.
        Returns:
        A Composite PathCondition.

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object