io.atomix.copycat.server.storage.compaction

Enum Compaction

java.lang.Object

java.lang.Enum<Compaction>

io.atomix.copycat.server.storage.compaction.Compaction

All Implemented Interfaces:

Serializable, Comparable<Compaction>

public enum Compaction
extends Enum<Compaction>

Log compaction type identifier.

Log compaction comes in two forms: MINOR and MAJOR. This enum provides identifiers to indicate the log compaction type when compacting the log. Passing an explicit Compaction type will run the appropriate compaction process asynchronously.

   
   log.compactor().compact(Compaction.MAJOR);
   
 

Author:

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Compaction.Mode Constants for specifying entry compaction modes.

Enum Constant Summary

Enum Constants

Enum Constant and Description
MAJOR Represents a major compaction.
MINOR Represents a minor compaction.

Method Summary

Modifier and Type	Method and Description
static Compaction	valueOf(String name) Returns the enum constant of this type with the specified name.
static Compaction[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

MINOR

public static final Compaction MINOR

Represents a minor compaction.

Minor compaction is the more efficient of the compaction processes which removes cleaned non-tombstone entries from individual Segments. See the MinorCompactionTask for more information.

MAJOR

public static final Compaction MAJOR

Represents a major compaction.

Major compaction is the more heavyweight process of removing all cleaned entries that have been committed to the log and combining segment files wherever possible. See the MajorCompactionTask for more information.

Method Detail

values

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

Returns:

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

valueOf

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