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

Class DefaultRolloverStrategy.Builder

java.lang.Object

org.apache.logging.log4j.core.appender.rolling.DefaultRolloverStrategy.Builder

All Implemented Interfaces:

Builder<DefaultRolloverStrategy>

Enclosing class:

DefaultRolloverStrategy

public static class DefaultRolloverStrategy.Builder
extends Object
implements Builder<DefaultRolloverStrategy>

Builds DefaultRolloverStrategy instances.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
DefaultRolloverStrategy	build() Builds the object after all configuration has been set.
String	getCompressionLevelStr()
Configuration	getConfig()
Action[]	getCustomActions()
String	getFileIndex()
String	getMax()
String	getMin()
String	getTempCompressedFilePattern()
boolean	isStopCustomActionsOnError()
DefaultRolloverStrategy.Builder	withCompressionLevelStr(String compressionLevelStr) Defines compression level.
DefaultRolloverStrategy.Builder	withConfig(Configuration config) Defines configuration.
DefaultRolloverStrategy.Builder	withCustomActions(Action[] customActions) Defines custom actions.
DefaultRolloverStrategy.Builder	withFileIndex(String fileIndex) Defines the file index for rolling strategy.
DefaultRolloverStrategy.Builder	withMax(String max) Defines the maximum number of files to keep.
DefaultRolloverStrategy.Builder	withMin(String min) Defines the minimum number of files to keep.
DefaultRolloverStrategy.Builder	withStopCustomActionsOnError(boolean stopCustomActionsOnError) Defines whether to stop executing asynchronous actions if an error occurs.
DefaultRolloverStrategy.Builder	withTempCompressedFilePattern(String tempCompressedFilePattern) Defines temporary compression file pattern.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.logging.log4j.core.util.Builder

getErrorPrefix, isValid

Constructor Detail

Builder

public Builder()

Method Detail

build

public DefaultRolloverStrategy build()

Description copied from interface: Builder

Builds the object after all configuration has been set. This will use default values for any unspecified attributes for the object.

Specified by:

build in interface Builder<DefaultRolloverStrategy>

Returns:

the configured instance.

getMax

public String getMax()

withMax

public DefaultRolloverStrategy.Builder withMax(String max)

Defines the maximum number of files to keep.

Parameters:

max - The maximum number of files to keep.

Returns:

This builder for chaining convenience

getMin

public String getMin()

withMin

public DefaultRolloverStrategy.Builder withMin(String min)

Defines the minimum number of files to keep.

Parameters:

min - The minimum number of files to keep.

Returns:

This builder for chaining convenience

getFileIndex

public String getFileIndex()

withFileIndex

public DefaultRolloverStrategy.Builder withFileIndex(String fileIndex)

Defines the file index for rolling strategy.

Parameters:

fileIndex - If set to "max" (the default), files with a higher index will be newer than files with a smaller index. If set to "min", file renaming and the counter will follow the Fixed Window strategy.

Returns:

This builder for chaining convenience

getCompressionLevelStr

public String getCompressionLevelStr()

withCompressionLevelStr

public DefaultRolloverStrategy.Builder withCompressionLevelStr(String compressionLevelStr)

Defines compression level.

Parameters:

compressionLevelStr - The compression level, 0 (less) through 9 (more); applies only to ZIP files.

Returns:

This builder for chaining convenience

getCustomActions

public Action[] getCustomActions()

withCustomActions

public DefaultRolloverStrategy.Builder withCustomActions(Action[] customActions)

Defines custom actions.

Parameters:

customActions - custom actions to perform asynchronously after rollover

Returns:

This builder for chaining convenience

isStopCustomActionsOnError

public boolean isStopCustomActionsOnError()

withStopCustomActionsOnError

public DefaultRolloverStrategy.Builder withStopCustomActionsOnError(boolean stopCustomActionsOnError)

Defines whether to stop executing asynchronous actions if an error occurs.

Parameters:

stopCustomActionsOnError - whether to stop executing asynchronous actions if an error occurs

Returns:

This builder for chaining convenience

getTempCompressedFilePattern

public String getTempCompressedFilePattern()

withTempCompressedFilePattern

public DefaultRolloverStrategy.Builder withTempCompressedFilePattern(String tempCompressedFilePattern)

Defines temporary compression file pattern.

Parameters:

tempCompressedFilePattern - File pattern of the working file pattern used during compression, if null no temporary file are used

Returns:

This builder for chaining convenience

getConfig

public Configuration getConfig()

withConfig

public DefaultRolloverStrategy.Builder withConfig(Configuration config)

Defines configuration.

Parameters:

config - The Configuration.

Returns:

This builder for chaining convenience