org.wildfly.swarm.config.logging

## Class PeriodicSizeRotatingFileHandler<T extends PeriodicSizeRotatingFileHandler<T>>

- java.lang.Object
- - org.wildfly.swarm.config.logging.PeriodicSizeRotatingFileHandler<T>

-     public class PeriodicSizeRotatingFileHandler<T extends PeriodicSizeRotatingFileHandler<T>>
      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)`

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `addPropertyChangeListener(PropertyChangeListener listener)` Adds a property change listener
    `Boolean` | `append()` Specify whether to append to the target file.
    `T` | `append(Boolean value)` Specify whether to append to the target file.
    `Boolean` | `autoflush()` Automatically flush after each write.
    `T` | `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.
    `T` | `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.
    `T` | `encoding(String value)` The character encoding used by this Handler.
    `Map` | `file()` The file description consisting of the path and optional relative to path.
    `T` | `file(Map value)` The file description consisting of the path and optional relative to path.
    `T` | `file(String key, Object value)` The file description consisting of the path and optional relative to path.
    `String` | `filterSpec()` A filter expression value to define a filter.
    `T` | `filterSpec(String value)` A filter expression value to define a filter.
    `String` | `formatter()` Defines a pattern for the formatter.
    `T` | `formatter(String value)` Defines a pattern for the formatter.
    `String` | `getKey()`
    `Level` | `level()` The log level specifying which message levels will be logged by this logger.
    `T` | `level(Level value)` The log level specifying which message levels will be logged by this logger.
    `Integer` | `maxBackupIndex()` The maximum number of backups to keep.
    `T` | `maxBackupIndex(Integer value)` The maximum number of backups to keep.
    `String` | `name()` The name of the handler.
    `T` | `name(String value)` The name of the handler.
    `String` | `namedFormatter()` The name of the defined formatter to be used on the handler.
    `T` | `namedFormatter(String value)` The name of the defined formatter to be used on the handler.
    `void` | `removePropertyChangeListener(PropertyChangeListener listener)` Removes a property change listener
    `Boolean` | `rotateOnBoot()` Indicates the file should be rotated each time the file attribute is changed.
    `T` | `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.
    `T` | `rotateSize(String value)` The size at which to rotate the log file.
    `String` | `suffix()` Set the suffix string.
    `T` | `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()

    - #### addPropertyChangeListener

          public void addPropertyChangeListener(PropertyChangeListener listener)

      Adds a property change listener

    - #### removePropertyChangeListener

          public void removePropertyChangeListener(PropertyChangeListener listener)

      Removes a property change listener

    - #### append

          public Boolean append()

      Specify whether to append to the target file.

    - #### append

          public T append(Boolean value)

      Specify whether to append to the target file.

    - #### autoflush

          public Boolean autoflush()

      Automatically flush after each write.

    - #### autoflush

          public T 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 T 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 T 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 T file(Map value)

      The file description consisting of the path and optional relative to path.

    - #### file

          public T file(String key,
                        Object 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 T 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 T formatter(String value)

      Defines a pattern for the formatter.

    - #### level

          public Level 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 T level(Level 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 T maxBackupIndex(Integer value)

      The maximum number of backups to keep.

    - #### name

          public String name()

      The name of the handler.

    - #### name

          public T name(String value)

      The name of the handler.

    - #### namedFormatter

          public String namedFormatter()

      The name of the defined formatter to be used on the handler.

    - #### namedFormatter

          public T 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 T 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 T 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 T 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.

Copyright © 2017 JBoss by Red Hat. All rights reserved.