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 Object
implements Builder<DirectWriteRolloverStrategy>
Builds DirectWriteRolloverStrategy instances.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds the object after all configuration has been set.Action[]booleansetCompressionLevelStr(String compressionLevelStr) Defines compression level.setConfig(Configuration config) Defines configuration.setCustomActions(Action[] customActions) Defines custom actions.setMaxFiles(String maxFiles) Defines the maximum number of files to keep.setStopCustomActionsOnError(boolean stopCustomActionsOnError) Defines whether to stop executing asynchronous actions if an error occurs.setTempCompressedFilePattern(String tempCompressedFilePattern) Defines temporary compression file pattern.withCompressionLevelStr(String compressionLevelStr) Deprecated.withConfig(Configuration config) Deprecated.since 2.26.0 usesetConfig(Configuration).withCustomActions(Action[] customActions) Deprecated.since 2.26.0 usesetCustomActions(Action[]).withMaxFiles(String maxFiles) Deprecated.since 2.26.0 usesetMaxFiles(String).withStopCustomActionsOnError(boolean stopCustomActionsOnError) Deprecated.since 2.26.0 usesetStopCustomActionsOnError(boolean).withTempCompressedFilePattern(String tempCompressedFilePattern) Deprecated.since 2.26.0 usesetTempCompressedFilePattern(String).Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.apache.logging.log4j.core.util.Builder
getErrorPrefix, isValid
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
build
Description copied from interface:BuilderBuilds the object after all configuration has been set. This will use default values for any unspecified attributes for the object.- Specified by:
buildin interfaceBuilder<DirectWriteRolloverStrategy>- Returns:
- the configured instance.
-
getMaxFiles
-
setMaxFiles
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
-
setCompressionLevelStr
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
-
setCustomActions
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
-
setTempCompressedFilePattern
public DirectWriteRolloverStrategy.Builder setTempCompressedFilePattern(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
-
setConfig
Defines configuration.- Parameters:
config- The Configuration.- Returns:
- This builder for chaining convenience
- Since:
- 2.26.0
-
withMaxFiles
Deprecated.since 2.26.0 usesetMaxFiles(String). -
withCompressionLevelStr
@Deprecated public DirectWriteRolloverStrategy.Builder withCompressionLevelStr(String compressionLevelStr) Deprecated.since 2.26.0 usesetCompressionLevelStr(String). -
withCustomActions
Deprecated.since 2.26.0 usesetCustomActions(Action[]). -
withStopCustomActionsOnError
@Deprecated public DirectWriteRolloverStrategy.Builder withStopCustomActionsOnError(boolean stopCustomActionsOnError) Deprecated.since 2.26.0 usesetStopCustomActionsOnError(boolean). -
withTempCompressedFilePattern
@Deprecated public DirectWriteRolloverStrategy.Builder withTempCompressedFilePattern(String tempCompressedFilePattern) Deprecated.since 2.26.0 usesetTempCompressedFilePattern(String). -
withConfig
Deprecated.since 2.26.0 usesetConfig(Configuration).
-
setCompressionLevelStr(String).