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

Class DirectWriteRolloverStrategy.Builder

java.lang.Object

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

All Implemented Interfaces:

Builder<DirectWriteRolloverStrategy>

Enclosing class:

DirectWriteRolloverStrategy

public static class DirectWriteRolloverStrategy.Builder
extends java.lang.Object
implements Builder<DirectWriteRolloverStrategy>

Builds DirectWriteRolloverStrategy instances.

Field Summary

Fields

Modifier and Type	Field	Description
private java.lang.String	compressionLevelStr
private Configuration	config
private Action[]	customActions
private java.lang.String	maxFiles
private boolean	stopCustomActionsOnError
private java.lang.String	tempCompressedFilePattern

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DirectWriteRolloverStrategy	build()	Builds the object after all configuration has been set.
java.lang.String	getCompressionLevelStr()
Configuration	getConfig()
Action[]	getCustomActions()
java.lang.String	getMaxFiles()
java.lang.String	getTempCompressedFilePattern()
boolean	isStopCustomActionsOnError()
DirectWriteRolloverStrategy.Builder	setCompressionLevelStr(java.lang.String compressionLevelStr)	Defines compression level.
DirectWriteRolloverStrategy.Builder	setConfig(Configuration config)	Defines configuration.
DirectWriteRolloverStrategy.Builder	setCustomActions(Action[] customActions)	Defines custom actions.
DirectWriteRolloverStrategy.Builder	setMaxFiles(java.lang.String maxFiles)	Defines the maximum number of files to keep.
DirectWriteRolloverStrategy.Builder	setStopCustomActionsOnError(boolean stopCustomActionsOnError)	Defines whether to stop executing asynchronous actions if an error occurs.
DirectWriteRolloverStrategy.Builder	setTempCompressedFilePattern(java.lang.String tempCompressedFilePattern)	Defines temporary compression file pattern.
DirectWriteRolloverStrategy.Builder	withCompressionLevelStr(java.lang.String compressionLevelStr)	Deprecated. since 2.26.0 use setCompressionLevelStr(String).
DirectWriteRolloverStrategy.Builder	withConfig(Configuration config)	Deprecated. since 2.26.0 use setConfig(Configuration).
DirectWriteRolloverStrategy.Builder	withCustomActions(Action[] customActions)	Deprecated. since 2.26.0 use setCustomActions(Action[]).
DirectWriteRolloverStrategy.Builder	withMaxFiles(java.lang.String maxFiles)	Deprecated. since 2.26.0 use setMaxFiles(String).
DirectWriteRolloverStrategy.Builder	withStopCustomActionsOnError(boolean stopCustomActionsOnError)	Deprecated. since 2.26.0 use setStopCustomActionsOnError(boolean).
DirectWriteRolloverStrategy.Builder	withTempCompressedFilePattern(java.lang.String tempCompressedFilePattern)	Deprecated. since 2.26.0 use setTempCompressedFilePattern(String).

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

Field Detail

maxFiles

@PluginBuilderAttribute("maxFiles")
private java.lang.String maxFiles

compressionLevelStr

@PluginBuilderAttribute("compressionLevel")
private java.lang.String compressionLevelStr

customActions

@PluginElement("Actions")
private Action[] customActions

stopCustomActionsOnError

@PluginBuilderAttribute("stopCustomActionsOnError")
private boolean stopCustomActionsOnError

tempCompressedFilePattern

@PluginBuilderAttribute("tempCompressedFilePattern")
private java.lang.String tempCompressedFilePattern

config

@PluginConfiguration
private Configuration config

Constructor Detail

Builder

public Builder()

Method Detail

build

public DirectWriteRolloverStrategy 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<DirectWriteRolloverStrategy>

Returns:

the configured instance.

getMaxFiles

public java.lang.String getMaxFiles()

setMaxFiles

public DirectWriteRolloverStrategy.Builder setMaxFiles(java.lang.String maxFiles)

Defines the maximum number of files to keep.

Parameters:

maxFiles - The maximum number of files that match the date portion of the pattern to keep.

Returns:

This builder for chaining convenience

Since:

2.26.0

getCompressionLevelStr

public java.lang.String getCompressionLevelStr()

setCompressionLevelStr

public DirectWriteRolloverStrategy.Builder setCompressionLevelStr(java.lang.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

Since:

2.26.0

getCustomActions

public Action[] getCustomActions()

setCustomActions

public DirectWriteRolloverStrategy.Builder setCustomActions(Action[] customActions)

Defines custom actions.

Parameters:

customActions - custom actions to perform asynchronously after rollover

Returns:

This builder for chaining convenience

Since:

2.26.0

isStopCustomActionsOnError

public boolean isStopCustomActionsOnError()

setStopCustomActionsOnError

public DirectWriteRolloverStrategy.Builder setStopCustomActionsOnError(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

Since:

2.26.0

getTempCompressedFilePattern

public java.lang.String getTempCompressedFilePattern()

setTempCompressedFilePattern

public DirectWriteRolloverStrategy.Builder setTempCompressedFilePattern(java.lang.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

Since:

2.26.0

getConfig

public Configuration getConfig()

setConfig

public DirectWriteRolloverStrategy.Builder setConfig(Configuration config)

Defines configuration.

Parameters:

config - The Configuration.

Returns:

This builder for chaining convenience

Since:

2.26.0

withMaxFiles

@Deprecated
public DirectWriteRolloverStrategy.Builder withMaxFiles(java.lang.String maxFiles)

Deprecated.

since 2.26.0 use setMaxFiles(String).

withCompressionLevelStr

@Deprecated
public DirectWriteRolloverStrategy.Builder withCompressionLevelStr(java.lang.String compressionLevelStr)

Deprecated.

since 2.26.0 use setCompressionLevelStr(String).

withCustomActions

@Deprecated
public DirectWriteRolloverStrategy.Builder withCustomActions(Action[] customActions)

Deprecated.

since 2.26.0 use setCustomActions(Action[]).

withStopCustomActionsOnError

@Deprecated
public DirectWriteRolloverStrategy.Builder withStopCustomActionsOnError(boolean stopCustomActionsOnError)

Deprecated.

since 2.26.0 use setStopCustomActionsOnError(boolean).

withTempCompressedFilePattern

@Deprecated
public DirectWriteRolloverStrategy.Builder withTempCompressedFilePattern(java.lang.String tempCompressedFilePattern)

Deprecated.

since 2.26.0 use setTempCompressedFilePattern(String).

withConfig

@Deprecated
public DirectWriteRolloverStrategy.Builder withConfig(Configuration config)

Deprecated.

since 2.26.0 use setConfig(Configuration).