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

Interface Action

All Superinterfaces:
Runnable
All Known Implementing Classes:
AbstractAction, AbstractPathAction, CommonsCompressAction, CompositeAction, DeleteAction, FileRenameAction, GzCompressAction, PosixViewAttributeAction, ZipCompressAction
public interface Action extends Runnable
The Action interface should be implemented by any class that performs file system actions for RollingFileAppenders after the close of the active log file.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    close()
    Cancels the action if not already initialized or waits till completion.
    boolean
    execute()
    Perform an action.
    boolean
    isComplete()
    Determines if action has been completed.

    Methods inherited from interface java.lang.Runnable

    run

  • Method Details

    • execute

      boolean execute() throws IOException
      Perform an action.
      Returns:
      true if action was successful. A return value of false will cause the rollover to be aborted if possible.
      Throws:
      IOException - if IO error, a thrown exception will cause the rollover to be aborted if possible.

    • close

      void close()
      Cancels the action if not already initialized or waits till completion.

    • isComplete

      boolean isComplete()
      Determines if action has been completed.
      Returns:
      true if action is complete.