org.apache.log4j.rolling

## Class SizeBasedTriggeringPolicy

- java.lang.Object
- - org.apache.log4j.rolling.SizeBasedTriggeringPolicy

- All Implemented Interfaces:
    TriggeringPolicy, org.apache.log4j.spi.OptionHandler

      public final class SizeBasedTriggeringPolicy
      extends Object
      implements TriggeringPolicy, org.apache.log4j.spi.OptionHandler

  SizeBasedTriggeringPolicy looks at size of the file being currently written to.
  Author:
    Ceki Gülcü, Curt Arnold

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `SizeBasedTriggeringPolicy()` Constructs a new instance.
    `SizeBasedTriggeringPolicy(long maxFileSize)` Constructs an new instance.

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `activateOptions()` Prepares policy for use.
    `long` | `getMaxFileSize()` Gets rollover threshold size in bytes.
    `boolean` | `isTriggeringEvent(org.apache.log4j.Appender appender, org.apache.log4j.spi.LoggingEvent event, String file, long fileLength)` Determines if a rollover may be appropriate at this time.
    `void` | `setMaxFileSize(long l)` Sets rollover threshold size in bytes.

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Constructor Detail

    - #### SizeBasedTriggeringPolicy

          public SizeBasedTriggeringPolicy()

      Constructs a new instance.

    - #### SizeBasedTriggeringPolicy

          public SizeBasedTriggeringPolicy(long maxFileSize)

      Constructs an new instance.
      Parameters:
        `maxFileSize` - rollover threshold size in bytes.

  - ### Method Detail

    - #### isTriggeringEvent

          public boolean isTriggeringEvent(org.apache.log4j.Appender appender,
                                  org.apache.log4j.spi.LoggingEvent event,
                                  String file,
                                  long fileLength)

      Determines if a rollover may be appropriate at this time. If true is returned, RolloverPolicy.rollover will be called but it can determine that a rollover is not warranted.
      Specified by:
        `isTriggeringEvent` in interface `TriggeringPolicy`
      Parameters:
        `appender` - A reference to the appender.
        `event` - A reference to the currently event.
        `file` - The filename for the currently active log file.
        `fileLength` - Length of the file in bytes.
      Returns:
        true if a rollover should occur.

    - #### getMaxFileSize

          public long getMaxFileSize()

      Gets rollover threshold size in bytes.
      Returns:
        rollover threshold size in bytes.

    - #### setMaxFileSize

          public void setMaxFileSize(long l)

      Sets rollover threshold size in bytes.
      Parameters:
        `l` - new value for rollover threshold size.

    - #### activateOptions

          public void activateOptions()

      Prepares policy for use.
      Specified by:
        `activateOptions` in interface `org.apache.log4j.spi.OptionHandler`

Copyright © 2013 The Apache Software Foundation. Licensed under the Apache License, Version 2.0

Apache Extras for Apache log4j, Apache log4j and Apache are trademarks of the Apache Software Foundation.