com.kdgregory.log4j.aws.internal.shared

Enum RotationMode

java.lang.Object

java.lang.Enum<RotationMode>

com.kdgregory.log4j.aws.internal.shared.RotationMode

All Implemented Interfaces:

Serializable, Comparable<RotationMode>

public enum RotationMode
extends Enum<RotationMode>

Defines the ways that we'll rotate logs (for appenders that support rotate).

Enum Constant Summary

Enum Constants

Enum Constant and Description
count Rotation is based on number of records.
daily Rotation happens with the first message after midnight UTC
hourly Rotation happens with the first message after every hour.
interval Rotation is controlled by the rotationInterval parameter.
none Rotation is disabled.

Method Summary

Modifier and Type	Method and Description
static RotationMode	lookup(String value) Finds the rotation mode corresponding to a passed string (case-insensitive).
static RotationMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static RotationMode[]	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

none

public static final RotationMode none

Rotation is disabled.

count

public static final RotationMode count

Rotation is based on number of records.

interval

public static final RotationMode interval

Rotation is controlled by the rotationInterval parameter.

hourly

public static final RotationMode hourly

Rotation happens with the first message after every hour.

daily

public static final RotationMode daily

Rotation happens with the first message after midnight UTC

Method Detail

values

public static RotationMode[] 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 (RotationMode c : RotationMode.values())
    System.out.println(c);

Returns:

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

valueOf

public static RotationMode 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

lookup

public static RotationMode lookup(String value)

Finds the rotation mode corresponding to a passed string (case-insensitive). Unable to find a matching mode, logs to the Log4J intenal logger and returns none.