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

Class TimeBasedTriggeringPolicy

java.lang.Object

org.apache.logging.log4j.core.AbstractLifeCycle

org.apache.logging.log4j.core.appender.rolling.AbstractTriggeringPolicy

org.apache.logging.log4j.core.appender.rolling.TimeBasedTriggeringPolicy

All Implemented Interfaces:

TriggeringPolicy, LifeCycle, LifeCycle2

@Plugin(name="TimeBasedTriggeringPolicy",
        category="Core",
        printObject=true)
public final class TimeBasedTriggeringPolicy
extends AbstractTriggeringPolicy

Rolls a file over based on time.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TimeBasedTriggeringPolicy.Builder

Nested classes/interfaces inherited from interface org.apache.logging.log4j.core.LifeCycle

LifeCycle.State

Field Summary

Fields

Modifier and Type	Field	Description
private int	interval
private RollingFileManager	manager
private long	maxRandomDelayMillis
private boolean	modulate
private long	nextRolloverMillis

Fields inherited from class org.apache.logging.log4j.core.AbstractLifeCycle

DEFAULT_STOP_TIMEOUT, DEFAULT_STOP_TIMEUNIT, LOGGER

Constructor Summary

Constructors

Modifier	Constructor	Description
private	TimeBasedTriggeringPolicy(int interval, boolean modulate, long maxRandomDelayMillis)

Method Summary

Modifier and Type	Method	Description
static TimeBasedTriggeringPolicy	createPolicy(java.lang.String interval, java.lang.String modulate)	Deprecated. Use newBuilder().
int	getInterval()
long	getNextRolloverMillis()
void	initialize(RollingFileManager aManager)	Initializes the policy.
boolean	isTriggeringEvent(LogEvent event)	Determines whether a rollover should occur.
static TimeBasedTriggeringPolicy.Builder	newBuilder()
java.lang.String	toString()

Methods inherited from class org.apache.logging.log4j.core.AbstractLifeCycle

equalsImpl, getState, getStatusLogger, hashCodeImpl, initialize, isInitialized, isStarted, isStarting, isStopped, isStopping, setStarted, setStarting, setState, setStopped, setStopping, start, stop, stop, stop

Methods inherited from class java.lang.Object

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

Field Detail

nextRolloverMillis

private long nextRolloverMillis

interval

private final int interval

modulate

private final boolean modulate

maxRandomDelayMillis

private final long maxRandomDelayMillis

manager

private RollingFileManager manager

Constructor Detail

TimeBasedTriggeringPolicy

private TimeBasedTriggeringPolicy(int interval,
                                  boolean modulate,
                                  long maxRandomDelayMillis)

Method Detail

getInterval

public int getInterval()

getNextRolloverMillis

public long getNextRolloverMillis()

initialize

public void initialize(RollingFileManager aManager)

Initializes the policy.

Parameters:

aManager - The RollingFileManager.

isTriggeringEvent

public boolean isTriggeringEvent(LogEvent event)

Determines whether a rollover should occur.

Parameters:

event - A reference to the currently event.

Returns:

true if a rollover should occur.

createPolicy

@Deprecated
public static TimeBasedTriggeringPolicy createPolicy(@PluginAttribute("interval")
                                                     java.lang.String interval,
                                                     @PluginAttribute("modulate")
                                                     java.lang.String modulate)

Deprecated.

Use newBuilder().

Creates a TimeBasedTriggeringPolicy.

Parameters:

interval - The interval between rollovers.

modulate - If true the time will be rounded to occur on a boundary aligned with the increment.

Returns:

a TimeBasedTriggeringPolicy.

newBuilder

@PluginBuilderFactory
public static TimeBasedTriggeringPolicy.Builder newBuilder()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object