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 java.lang.Object
implements Builder<DefaultRolloverStrategy>
```
Builds DefaultRolloverStrategy instances.

Field Summary

Fields
Modifier and Type	Field	Description
`private java.lang.String`	`compressionLevelStr`
`private Configuration`	`config`
`private Action[]`	`customActions`
`private java.lang.String`	`fileIndex`
`private java.lang.String`	`max`
`private java.lang.String`	`min`
`private boolean`	`stopCustomActionsOnError`
`private java.lang.String`	`tempCompressedFilePattern`

Constructor Summary

Constructors
Constructor Description

Builder()

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`DefaultRolloverStrategy`	`build()`	Builds the object after all configuration has been set.
`java.lang.String`	`getCompressionLevelStr()`
`Configuration`	`getConfig()`
`Action[]`	`getCustomActions()`
`java.lang.String`	`getFileIndex()`
`java.lang.String`	`getMax()`
`java.lang.String`	`getMin()`
`java.lang.String`	`getTempCompressedFilePattern()`
`boolean`	`isStopCustomActionsOnError()`
`DefaultRolloverStrategy.Builder`	`setCompressionLevelStr(java.lang.String compressionLevelStr)`	Defines compression level.
`DefaultRolloverStrategy.Builder`	`setConfig(Configuration config)`	Defines configuration.
`DefaultRolloverStrategy.Builder`	`setCustomActions(Action[] customActions)`	Defines custom actions.
`DefaultRolloverStrategy.Builder`	`setFileIndex(java.lang.String fileIndex)`	Defines the file index for rolling strategy.
`DefaultRolloverStrategy.Builder`	`setMax(java.lang.String max)`	Defines the maximum number of files to keep.
`DefaultRolloverStrategy.Builder`	`setMin(java.lang.String min)`	Defines the minimum number of files to keep.
`DefaultRolloverStrategy.Builder`	`setStopCustomActionsOnError(boolean stopCustomActionsOnError)`	Defines whether to stop executing asynchronous actions if an error occurs.
`DefaultRolloverStrategy.Builder`	`setTempCompressedFilePattern(java.lang.String tempCompressedFilePattern)`	Defines temporary compression file pattern.
`DefaultRolloverStrategy.Builder`	`withCompressionLevelStr(java.lang.String compressionLevelStr)`	Deprecated. since 2.26.0 use `setCompressionLevelStr(String)`.
`DefaultRolloverStrategy.Builder`	`withConfig(Configuration config)`	Deprecated. since 2.26.0 use `setConfig(Configuration)`.
`DefaultRolloverStrategy.Builder`	`withCustomActions(Action[] customActions)`	Deprecated. since 2.26.0 use `setCustomActions(Action[])`.
`DefaultRolloverStrategy.Builder`	`withFileIndex(java.lang.String fileIndex)`	Deprecated. since 2.26.0 use `setFileIndex(String)`.
`DefaultRolloverStrategy.Builder`	`withMax(java.lang.String max)`	Deprecated. since 2.26.0 use `setMax(String)`.
`DefaultRolloverStrategy.Builder`	`withMin(java.lang.String min)`	Deprecated. since 2.26.0 use `setMin(String)`.
`DefaultRolloverStrategy.Builder`	`withStopCustomActionsOnError(boolean stopCustomActionsOnError)`	Deprecated. since 2.26.0 use `setStopCustomActionsOnError(boolean)`.
`DefaultRolloverStrategy.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
  - max
```
@PluginBuilderAttribute("max")
private java.lang.String max
```
  - min
```
@PluginBuilderAttribute("min")
private java.lang.String min
```
  - fileIndex
```
@PluginBuilderAttribute("fileIndex")
private java.lang.String fileIndex
```
  - 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 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 java.lang.String getMax()
```
  - setMax
```
public DefaultRolloverStrategy.Builder setMax(java.lang.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
    
    Since:
    
    2.26.0
  - getMin
```
public java.lang.String getMin()
```
  - setMin
```
public DefaultRolloverStrategy.Builder setMin(java.lang.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
    
    Since:
    
    2.26.0
  - getFileIndex
```
public java.lang.String getFileIndex()
```
  - setFileIndex
```
public DefaultRolloverStrategy.Builder setFileIndex(java.lang.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
    
    Since:
    
    2.26.0
  - getCompressionLevelStr
```
public java.lang.String getCompressionLevelStr()
```
  - setCompressionLevelStr
```
public DefaultRolloverStrategy.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 DefaultRolloverStrategy.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 DefaultRolloverStrategy.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 DefaultRolloverStrategy.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 DefaultRolloverStrategy.Builder setConfig(Configuration config)
```
    Defines configuration.
    
    Parameters:
    
    config - The Configuration.
    
    Returns:
    
    This builder for chaining convenience
    
    Since:
    
    2.26.0
  - withMax
```
@Deprecated
public DefaultRolloverStrategy.Builder withMax(java.lang.String max)
```
    Deprecated.
    since 2.26.0 use setMax(String).
  - withMin
```
@Deprecated
public DefaultRolloverStrategy.Builder withMin(java.lang.String min)
```
    Deprecated.
    since 2.26.0 use setMin(String).
  - withFileIndex
```
@Deprecated
public DefaultRolloverStrategy.Builder withFileIndex(java.lang.String fileIndex)
```
    Deprecated.
    since 2.26.0 use setFileIndex(String).
  - withCompressionLevelStr
```
@Deprecated
public DefaultRolloverStrategy.Builder withCompressionLevelStr(java.lang.String compressionLevelStr)
```
    Deprecated.
    since 2.26.0 use setCompressionLevelStr(String).
  - withCustomActions
```
@Deprecated
public DefaultRolloverStrategy.Builder withCustomActions(Action[] customActions)
```
    Deprecated.
    since 2.26.0 use setCustomActions(Action[]).
  - withStopCustomActionsOnError
```
@Deprecated
public DefaultRolloverStrategy.Builder withStopCustomActionsOnError(boolean stopCustomActionsOnError)
```
    Deprecated.
    since 2.26.0 use setStopCustomActionsOnError(boolean).
  - withTempCompressedFilePattern
```
@Deprecated
public DefaultRolloverStrategy.Builder withTempCompressedFilePattern(java.lang.String tempCompressedFilePattern)
```
    Deprecated.
    since 2.26.0 use setTempCompressedFilePattern(String).
  - withConfig
```
@Deprecated
public DefaultRolloverStrategy.Builder withConfig(Configuration config)
```
    Deprecated.
    since 2.26.0 use setConfig(Configuration).

Class DefaultRolloverStrategy.Builder

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

max

min

fileIndex

compressionLevelStr

customActions

stopCustomActionsOnError

tempCompressedFilePattern

config

Constructor Detail

Builder

Method Detail

build

getMax

setMax

getMin

setMin

getFileIndex

setFileIndex

getCompressionLevelStr

setCompressionLevelStr

getCustomActions

setCustomActions

isStopCustomActionsOnError

setStopCustomActionsOnError

getTempCompressedFilePattern

setTempCompressedFilePattern

getConfig

setConfig

withMax

withMin

withFileIndex

withCompressionLevelStr

withCustomActions

withStopCustomActionsOnError

withTempCompressedFilePattern

withConfig