org.x4juli.handlers.rolling.nop
Class NOPRollingPolicy

java.lang.Object
  org.x4juli.global.components.AbstractComponent
      org.x4juli.handlers.rolling.AbstractRollingPolicy
          org.x4juli.handlers.rolling.nop.NOPRollingPolicy

All Implemented Interfaces:

Component, OptionHandler, RollingPolicy

public final class NOPRollingPolicy

extends AbstractRollingPolicy

No rollover policy. Needed for default configuration in RollingFileHandler.

Since:

0.5

Author:

Boris Unckel

Field Summary

static NOPRollingPolicy

NOP_ROLLING_POLICY

Fields inherited from class org.x4juli.handlers.rolling.AbstractRollingPolicy

activeFileName

Fields inherited from class org.x4juli.global.components.AbstractComponent

manager, repository

Constructor Summary

private

NOPRollingPolicy()

Method Summary

void	activateOptions() Activate the options that were previously set with calls to option setters. This allows to defer activiation of the options until all options have been set. This is required for components which have related options that remain ambigous until all are set.
RolloverDescription	initialize(java.lang.String file, boolean append) Initialize the policy and return any initial actions for rolling file appender..
RolloverDescription	rollover(java.lang.String activeFile) Prepare for a rollover. This method is called prior to closing the active log file, performs any necessary preliminary actions and describes actions needed after close of current log file.

Methods inherited from class org.x4juli.handlers.rolling.AbstractRollingPolicy

configure, formatFileName, getDatePatternConverter, getFileNamePattern, getIntegerPatternConverter, getMessageProperties, parseFileNamePattern, setFileNamePattern, toString

Methods inherited from class org.x4juli.global.components.AbstractComponent

getLogger, getLoggerRepository, getNonFloodingLogger, getProperty, getProperty, getProperty, getProperty, resetErrorCount, setObjectStore

Methods inherited from class java.lang.Object

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

Field Detail

NOP_ROLLING_POLICY

public static final NOPRollingPolicy NOP_ROLLING_POLICY

Constructor Detail

NOPRollingPolicy

private NOPRollingPolicy()

Method Detail

initialize

public RolloverDescription initialize(java.lang.String file,
                                      boolean append)
                               throws java.lang.SecurityException

Initialize the policy and return any initial actions for rolling file appender..

Parameters:

file - current value of RollingFileHandler.getFile().

append - current value of RollingFileHandler.getAppend().

Returns:

Description of the initialization, may be null to indicate no initialization needed.

Throws:

java.lang.SecurityException - if denied access to log files.

Since:

0.5

rollover

public RolloverDescription rollover(java.lang.String activeFile)
                             throws java.lang.SecurityException

Prepare for a rollover. This method is called prior to closing the active log file, performs any necessary preliminary actions and describes actions needed after close of current log file.

Parameters:

activeFile - file name for current active log file.

Returns:

Description of pending rollover, may be null to indicate no rollover at this time.

Throws:

java.lang.SecurityException - if denied access to log files.

Since:

0.5

activateOptions

public void activateOptions()

Activate the options that were previously set with calls to option setters.

This allows to defer activiation of the options until all options have been set. This is required for components which have related options that remain ambigous until all are set.

Specified by:

activateOptions in interface OptionHandler

Overrides:

activateOptions in class AbstractRollingPolicy

Since:

0.5