Class RolloverDescriptionImpl

java.lang.Object
org.apache.log4j.rolling.RolloverDescriptionImpl
All Implemented Interfaces:
RolloverDescription

public final class RolloverDescriptionImpl extends Object implements RolloverDescription
Description of actions needed to complete rollover.
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final String
    Active log file name after rollover.
    private final boolean
    Should active file be opened for appending.
    private final Action
    Action to be completed after close of current active log file and before next rollover attempt, may be executed asynchronously.
    private final Action
    Action to be completed after close of current active log file before returning control to caller.
  • Constructor Summary

    Constructors
    Constructor
    Description
    RolloverDescriptionImpl(String activeFileName, boolean append, Action synchronous, Action asynchronous)
    Create new instance.
  • Method Summary

    Modifier and Type
    Method
    Description
    Active log file name after rollover.
    boolean
    Specifies if active file should be opened for appending.
    Action to be completed after close of current active log file and before next rollover attempt, may be executed asynchronously.
    Action to be completed after close of current active log file before returning control to caller.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Field Details

    • activeFileName

      private final String activeFileName
      Active log file name after rollover.
    • append

      private final boolean append
      Should active file be opened for appending.
    • synchronous

      private final Action synchronous
      Action to be completed after close of current active log file before returning control to caller.
    • asynchronous

      private final Action asynchronous
      Action to be completed after close of current active log file and before next rollover attempt, may be executed asynchronously.
  • Constructor Details

    • RolloverDescriptionImpl

      public RolloverDescriptionImpl(String activeFileName, boolean append, Action synchronous, Action asynchronous)
      Create new instance.
      Parameters:
      activeFileName - active log file name after rollover, may not be null.
      append - true if active log file after rollover should be opened for appending.
      synchronous - action to be completed after close of current active log file, may be null.
      asynchronous - action to be completed after close of current active log file and before next rollover attempt.
  • Method Details

    • getActiveFileName

      public String getActiveFileName()
      Active log file name after rollover.
      Specified by:
      getActiveFileName in interface RolloverDescription
      Returns:
      active log file name after rollover.
    • getAppend

      public boolean getAppend()
      Specifies if active file should be opened for appending.
      Specified by:
      getAppend in interface RolloverDescription
      Returns:
      if true, active file should be opened for appending.
    • getSynchronous

      public Action getSynchronous()
      Action to be completed after close of current active log file before returning control to caller.
      Specified by:
      getSynchronous in interface RolloverDescription
      Returns:
      action, may be null.
    • getAsynchronous

      public Action getAsynchronous()
      Action to be completed after close of current active log file and before next rollover attempt, may be executed asynchronously.
      Specified by:
      getAsynchronous in interface RolloverDescription
      Returns:
      action, may be null.