Class IfAccumulatedFileSize

java.lang.Object
org.apache.logging.log4j.core.appender.rolling.action.IfAccumulatedFileSize
All Implemented Interfaces:
PathCondition

@Plugin(name="IfAccumulatedFileSize", category="Core", printObject=true) public final class IfAccumulatedFileSize extends Object implements PathCondition
PathCondition that accepts paths after the accumulated file size threshold is exceeded during the file tree walk.
  • Method Details

    • getThresholdBytes

      public long getThresholdBytes()
    • getNestedConditions

      public List<PathCondition> getNestedConditions()
    • accept

      public boolean accept(Path basePath, Path relativePath, 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:
      basePath - 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
    • createFileSizeCondition

      @PluginFactory public static IfAccumulatedFileSize createFileSizeCondition(@PluginAttribute("exceeds") String size, @PluginElement("PathConditions") PathCondition... nestedConditions)
      Create an IfAccumulatedFileSize condition.
      Parameters:
      size - The threshold accumulated file size from which files will be deleted.
      Returns:
      An IfAccumulatedFileSize condition.
    • toString

      public String toString()
      Overrides:
      toString in class Object