com.neeve.rog.log
Enum RogLogCompactionReader.RunCompletionReason

java.lang.Object
  java.lang.Enum<RogLogCompactionReader.RunCompletionReason>
      com.neeve.rog.log.RogLogCompactionReader.RunCompletionReason

All Implemented Interfaces:

Serializable, Comparable<RogLogCompactionReader.RunCompletionReason>

Enclosing class:

RogLogCompactionReader

public static enum RogLogCompactionReader.RunCompletionReason
extends Enum<RogLogCompactionReader.RunCompletionReason>

Enumerates the various reasons why a RogLogCompactionReader.run(int, long) invocation completes

Enum Constant Summary

Closed
Indicates the compaction reader ws closed while the RogLogCompactionReader.run(int, long) was executing

EndOfFile
Indicates the RogLogCompactionReader.run(int, long) method reached the end of the file and detected that the last checkpoint had been rolled over to a new log file

LogNotCheckpointed
Indicates that the entries in the log are not checkpointed.

MaxFilePointerReached
Indicates the RogLogCompactionReader.run(int, long) method reached the max file pointer supplied by the caller to the run method.

Method Summary

static RogLogCompactionReader.RunCompletionReason	valueOf(String name) Returns the enum constant of this type with the specified name.
static RogLogCompactionReader.RunCompletionReason[]	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

LogNotCheckpointed

public static final RogLogCompactionReader.RunCompletionReason LogNotCheckpointed

Indicates that the entries in the log are not checkpointed.

EndOfFile

public static final RogLogCompactionReader.RunCompletionReason EndOfFile

Indicates the RogLogCompactionReader.run(int, long) method reached the end of the file and detected that the last checkpoint had been rolled over to a new log file

MaxFilePointerReached

public static final RogLogCompactionReader.RunCompletionReason MaxFilePointerReached

Indicates the RogLogCompactionReader.run(int, long) method reached the max file pointer supplied by the caller to the run method.

Closed

public static final RogLogCompactionReader.RunCompletionReason Closed

Indicates the compaction reader ws closed while the RogLogCompactionReader.run(int, long) was executing

Method Detail

values

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

Returns:

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

valueOf

public static RogLogCompactionReader.RunCompletionReason 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