PeriodicSizeRotatingFileHandler (api 0.3.4 API)

java.lang.Object
- org.wildfly.swarm.config.logging.PeriodicSizeRotatingFileHandler

```
public class PeriodicSizeRotatingFileHandler
extends Object
```
Defines a handler which writes to a file, rotating the log after a time period derived from the given suffix string or after the size of the file grows beyond a certain point and keeping a fixed number of backups. The suffix should be in a format understood by the java.text.SimpleDateFormat. Any backups rotated by the suffix will not be purged during a size rotation.

Constructor Summary

Constructors
Constructor and Description

PeriodicSizeRotatingFileHandler(String key)

Constructors
Constructor and Description
`PeriodicSizeRotatingFileHandler(String key)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Boolean`	`append()` Specify whether to append to the target file.
`PeriodicSizeRotatingFileHandler`	`append(Boolean value)` Specify whether to append to the target file.
`Boolean`	`autoflush()` Automatically flush after each write.
`PeriodicSizeRotatingFileHandler`	`autoflush(Boolean value)` Automatically flush after each write.
`Boolean`	`enabled()` If set to true the handler is enabled and functioning as normal, if set to false the handler is ignored when processing log messages.
`PeriodicSizeRotatingFileHandler`	`enabled(Boolean value)` If set to true the handler is enabled and functioning as normal, if set to false the handler is ignored when processing log messages.
`String`	`encoding()` The character encoding used by this Handler.
`PeriodicSizeRotatingFileHandler`	`encoding(String value)` The character encoding used by this Handler.
`Map`	`file()` The file description consisting of the path and optional relative to path.
`PeriodicSizeRotatingFileHandler`	`file(Map value)` The file description consisting of the path and optional relative to path.
`String`	`filterSpec()` A filter expression value to define a filter.
`PeriodicSizeRotatingFileHandler`	`filterSpec(String value)` A filter expression value to define a filter.
`String`	`formatter()` Defines a pattern for the formatter.
`PeriodicSizeRotatingFileHandler`	`formatter(String value)` Defines a pattern for the formatter.
`String`	`getKey()`
`String`	`level()` The log level specifying which message levels will be logged by this logger.
`PeriodicSizeRotatingFileHandler`	`level(String value)` The log level specifying which message levels will be logged by this logger.
`Integer`	`maxBackupIndex()` The maximum number of backups to keep.
`PeriodicSizeRotatingFileHandler`	`maxBackupIndex(Integer value)` The maximum number of backups to keep.
`String`	`namedFormatter()` The name of the defined formatter to be used on the handler.
`PeriodicSizeRotatingFileHandler`	`namedFormatter(String value)` The name of the defined formatter to be used on the handler.
`Boolean`	`rotateOnBoot()` Indicates the file should be rotated each time the file attribute is changed.
`PeriodicSizeRotatingFileHandler`	`rotateOnBoot(Boolean value)` Indicates the file should be rotated each time the file attribute is changed.
`String`	`rotateSize()` The size at which to rotate the log file.
`PeriodicSizeRotatingFileHandler`	`rotateSize(String value)` The size at which to rotate the log file.
`String`	`suffix()` Set the suffix string.
`PeriodicSizeRotatingFileHandler`	`suffix(String value)` Set the suffix string.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - PeriodicSizeRotatingFileHandler
```
public PeriodicSizeRotatingFileHandler(String key)
```
- Method Detail
  - getKey
```
public String getKey()
```
  - append
```
public Boolean append()
```
    Specify whether to append to the target file.
  - append
```
public PeriodicSizeRotatingFileHandler append(Boolean value)
```
    Specify whether to append to the target file.
  - autoflush
```
public Boolean autoflush()
```
    Automatically flush after each write.
  - autoflush
```
public PeriodicSizeRotatingFileHandler autoflush(Boolean value)
```
    Automatically flush after each write.
  - enabled
```
public Boolean enabled()
```
    If set to true the handler is enabled and functioning as normal, if set to false the handler is ignored when processing log messages.
  - enabled
```
public PeriodicSizeRotatingFileHandler enabled(Boolean value)
```
    If set to true the handler is enabled and functioning as normal, if set to false the handler is ignored when processing log messages.
  - encoding
```
public String encoding()
```
    The character encoding used by this Handler.
  - encoding
```
public PeriodicSizeRotatingFileHandler encoding(String value)
```
    The character encoding used by this Handler.
  - file
```
public Map file()
```
    The file description consisting of the path and optional relative to path.
  - file
```
public PeriodicSizeRotatingFileHandler file(Map value)
```
    The file description consisting of the path and optional relative to path.
  - filterSpec
```
public String filterSpec()
```
    A filter expression value to define a filter. Example for a filter that does not match a pattern: not(match("JBAS.*"))
  - filterSpec
```
public PeriodicSizeRotatingFileHandler filterSpec(String value)
```
    A filter expression value to define a filter. Example for a filter that does not match a pattern: not(match("JBAS.*"))
  - formatter
```
public String formatter()
```
    Defines a pattern for the formatter.
  - formatter
```
public PeriodicSizeRotatingFileHandler formatter(String value)
```
    Defines a pattern for the formatter.
  - level
```
public String level()
```
    The log level specifying which message levels will be logged by this logger. Message levels lower than this value will be discarded.
  - level
```
public PeriodicSizeRotatingFileHandler level(String value)
```
    The log level specifying which message levels will be logged by this logger. Message levels lower than this value will be discarded.
  - maxBackupIndex
```
public Integer maxBackupIndex()
```
    The maximum number of backups to keep.
  - maxBackupIndex
```
public PeriodicSizeRotatingFileHandler maxBackupIndex(Integer value)
```
    The maximum number of backups to keep.
  - namedFormatter
```
public String namedFormatter()
```
    The name of the defined formatter to be used on the handler.
  - namedFormatter
```
public PeriodicSizeRotatingFileHandler namedFormatter(String value)
```
    The name of the defined formatter to be used on the handler.
  - rotateOnBoot
```
public Boolean rotateOnBoot()
```
    Indicates the file should be rotated each time the file attribute is changed. This always happens when at initialization time.
  - rotateOnBoot
```
public PeriodicSizeRotatingFileHandler rotateOnBoot(Boolean value)
```
    Indicates the file should be rotated each time the file attribute is changed. This always happens when at initialization time.
  - rotateSize
```
public String rotateSize()
```
    The size at which to rotate the log file.
  - rotateSize
```
public PeriodicSizeRotatingFileHandler rotateSize(String value)
```
    The size at which to rotate the log file.
  - suffix
```
public String suffix()
```
    Set the suffix string. The string is in a format which can be understood by java.text.SimpleDateFormat. The period of the rotation is automatically calculated based on the suffix.
  - suffix
```
public PeriodicSizeRotatingFileHandler suffix(String value)
```
    Set the suffix string. The string is in a format which can be understood by java.text.SimpleDateFormat. The period of the rotation is automatically calculated based on the suffix.

Class PeriodicSizeRotatingFileHandler

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PeriodicSizeRotatingFileHandler

Method Detail

getKey

append

append

autoflush

autoflush

enabled

enabled

encoding

encoding

file

file

filterSpec

filterSpec

formatter

formatter

level

level

maxBackupIndex

maxBackupIndex

namedFormatter

namedFormatter

rotateOnBoot

rotateOnBoot

rotateSize

rotateSize

suffix

suffix