Class CompositeTriggeringPolicy

java.lang.Object

org.apache.log4j.rolling.CompositeTriggeringPolicy

All Implemented Interfaces:

TriggeringPolicy, org.apache.log4j.spi.OptionHandler, org.apache.log4j.xml.UnrecognizedElementHandler

public final class CompositeTriggeringPolicy
extends Object
implements TriggeringPolicy, org.apache.log4j.xml.UnrecognizedElementHandler

CompositeTriggeringPolicy determines if rolling should be triggered by evaluating the current event against a set of triggering policies. TriggeringPolicy results are OR'd together - if any of the triggering policies report rolling should occur, a rolling event will be triggered.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) Set	triggeringPolicies

Constructor Summary

Constructors

Constructor	Description
CompositeTriggeringPolicy()

Method Summary

Modifier and Type	Method	Description
void	activateOptions()
void	addTriggeringPolicy(TriggeringPolicy policy)	Add triggering policy
boolean	isTriggeringEvent(org.apache.log4j.Appender appender, org.apache.log4j.spi.LoggingEvent event, String file, long fileLength)	Determines if a rollover may be appropriate at this time.
boolean	parseUnrecognizedElement(Element element, Properties props)

Methods inherited from class Object

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

Field Details

triggeringPolicies

Set triggeringPolicies

Constructor Details

CompositeTriggeringPolicy

public CompositeTriggeringPolicy()

Method Details

isTriggeringEvent

public boolean isTriggeringEvent(org.apache.log4j.Appender appender,
 org.apache.log4j.spi.LoggingEvent event,
 String file,
 long fileLength)

Description copied from interface: TriggeringPolicy

Determines if a rollover may be appropriate at this time. If true is returned, RolloverPolicy.rollover will be called but it can determine that a rollover is not warranted.

Specified by:

isTriggeringEvent in interface TriggeringPolicy

Parameters:

appender - A reference to the appender.

event - A reference to the currently event.

file - The filename for the currently active log file.

fileLength - Length of the file in bytes.

Returns:

true if a rollover should occur.

addTriggeringPolicy

public void addTriggeringPolicy(TriggeringPolicy policy)

Add triggering policy

Parameters:

policy -

activateOptions

public void activateOptions()

Specified by:

activateOptions in interface org.apache.log4j.spi.OptionHandler

parseUnrecognizedElement

public boolean parseUnrecognizedElement(Element element,
 Properties props)
                                 throws Exception

Specified by:

parseUnrecognizedElement in interface org.apache.log4j.xml.UnrecognizedElementHandler

Throws:

Exception