org.apache.logging.log4j.core.appender.rolling
Enum RolloverFrequency

java.lang.Object
  extended by java.lang.Enum<RolloverFrequency>
      extended by org.apache.logging.log4j.core.appender.rolling.RolloverFrequency
All Implemented Interfaces:
Serializable, Comparable<RolloverFrequency>

public enum RolloverFrequency
extends Enum<RolloverFrequency>

Enumeration of rollover frequency values.


Enum Constant Summary
ANNUALLY
          Rollover annually.
DAILY
          Rollover daily.
EVERY_MILLISECOND
          Rollover every millisecond.
EVERY_MINUTE
          Rollover every minute.
EVERY_SECOND
          Rollover every second.
HOURLY
          Rollover every hour.
MONTHLY
          Rollover monthly.
WEEKLY
          Rollover weekly.
 
Method Summary
static RolloverFrequency valueOf(String name)
          Returns the enum constant of this type with the specified name.
static RolloverFrequency[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

ANNUALLY

public static final RolloverFrequency ANNUALLY
Rollover annually.


MONTHLY

public static final RolloverFrequency MONTHLY
Rollover monthly.


WEEKLY

public static final RolloverFrequency WEEKLY
Rollover weekly.


DAILY

public static final RolloverFrequency DAILY
Rollover daily.


HOURLY

public static final RolloverFrequency HOURLY
Rollover every hour.


EVERY_MINUTE

public static final RolloverFrequency EVERY_MINUTE
Rollover every minute.


EVERY_SECOND

public static final RolloverFrequency EVERY_SECOND
Rollover every second.


EVERY_MILLISECOND

public static final RolloverFrequency EVERY_MILLISECOND
Rollover every millisecond.

Method Detail

values

public static RolloverFrequency[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (RolloverFrequency c : RolloverFrequency.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static RolloverFrequency valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
IllegalArgumentException - if this enum type has no constant with the specified name
NullPointerException - if the argument is null


Copyright © 1999-2014 Apache Software Foundation. All Rights Reserved.
Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation.