org.x4juli.handlers.rolling
Class RolloverDescriptionImpl

java.lang.Object
  org.x4juli.handlers.rolling.RolloverDescriptionImpl

All Implemented Interfaces:

RolloverDescription

Direct Known Subclasses:

NOPRolloverDescription

public class RolloverDescriptionImpl

extends java.lang.Object

implements RolloverDescription

Description of actions needed to complete rollover.

Logging API as a whole was originally done for Apache log4j. Juli is a port of main parts of that to complete the Java Logging APIs. All credits for initial idea, design, implementation, documentation belong to the log4j crew. This file was originally published by Curt Arnold. Please use exclusively the appropriate mailing lists for questions, remarks and contribution.

Since:

0.5

Author:

Boris Unckel

Field Summary

private java.lang.String	activeFileName Active log file name after rollover.
private boolean	append Should active file be opened for appending.
private Action	asynchronous Action to be completed after close of current active log file and before next rollover attempt, may be executed asynchronously.
private Action	synchronous Action to be completed after close of current active log file before returning control to caller.

Constructor Summary

RolloverDescriptionImpl(java.lang.String activeFileName, boolean append, Action synchronous, Action asynchronous)
Create new instance.

Method Summary

java.lang.String	getActiveFileName() Active log file name after rollover.
boolean	getAppend() Specifies if active file should be opened for appending.
Action	getAsynchronous() Action to be completed after close of current active log file and before next rollover attempt, may be executed asynchronously.
Action	getSynchronous() 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 Detail

activeFileName

private final java.lang.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 Detail

RolloverDescriptionImpl

public RolloverDescriptionImpl(java.lang.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 Detail

getActiveFileName

public java.lang.String getActiveFileName()

Active log file name after rollover.

Specified by:

getActiveFileName in interface RolloverDescription

Returns:

active log file name after rollover.

Since:

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.

Since:

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.

Since:

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.

Since: