org.clapper.util.io

Enum RollingFileWriter.Compression

java.lang.Object

java.lang.Enum<RollingFileWriter.Compression>

org.clapper.util.io.RollingFileWriter.Compression

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<RollingFileWriter.Compression>

Enclosing class:

RollingFileWriter

public static enum RollingFileWriter.Compression
extends java.lang.Enum<RollingFileWriter.Compression>

An enumeration of constants defining whether or not to compress backup files. (Easier to read than a boolean.)

Enum Constant Summary

Enum Constants

Enum Constant and Description
COMPRESS_BACKUPS
DONT_COMPRESS_BACKUPS

Method Summary

Modifier and Type	Method and Description
static RollingFileWriter.Compression	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static RollingFileWriter.Compression[]	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

COMPRESS_BACKUPS

public static final RollingFileWriter.Compression COMPRESS_BACKUPS

DONT_COMPRESS_BACKUPS

public static final RollingFileWriter.Compression DONT_COMPRESS_BACKUPS

Method Detail

values

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

Returns:

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

valueOf

public static RollingFileWriter.Compression valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null