org.apache.samza.system

Enum SystemStreamMetadata.OffsetType

java.lang.Object

java.lang.Enum<SystemStreamMetadata.OffsetType>

org.apache.samza.system.SystemStreamMetadata.OffsetType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SystemStreamMetadata.OffsetType>

Enclosing class:

SystemStreamMetadata

public static enum SystemStreamMetadata.OffsetType
extends java.lang.Enum<SystemStreamMetadata.OffsetType>

OffsetType is an enum used to define which offset should be used when reading from a SystemStreamPartition for the first time.

Enum Constant Summary

Enum Constants

Enum Constant and Description
NEWEST Signals the offset of the newest message in a SystemStreamPartition.
OLDEST Signals the offset of the oldest message in a SystemStreamPartition.
UPCOMING Signals the offset of the next message to be written into a SystemStreamPartition.

Method Summary

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

OLDEST

public static final SystemStreamMetadata.OffsetType OLDEST

Signals the offset of the oldest message in a SystemStreamPartition.

NEWEST

public static final SystemStreamMetadata.OffsetType NEWEST

Signals the offset of the newest message in a SystemStreamPartition.

UPCOMING

public static final SystemStreamMetadata.OffsetType UPCOMING

Signals the offset of the next message to be written into a SystemStreamPartition. If the offset of the most recent message written to a SystemStreamPartition is 7, then upcoming would signal offset 8 (assuming the offsets were incremental).

Method Detail

values

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

Returns:

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

valueOf

public static SystemStreamMetadata.OffsetType 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