com.lightbend.lagom.javadsl.persistence

Class Offset

Object

com.lightbend.lagom.javadsl.persistence.Offset

Direct Known Subclasses:

Offset.NoOffset, Offset.Sequence, Offset.TimeBasedUUID

public abstract class Offset
extends Object

An offset.

Offsets are used for ordering of events, typically in event journals, so that consumers can keep track of what events they have and haven't consumed.

Akka persistence, which underlies Lagom's persistence APIs, uses different offset types for different persistence datastores. This class provides an abstraction over them. The two types currently supported are a long sequence number and a time based UUID.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Offset.NoOffset
static class	Offset.Sequence A sequence number offset, backed by a long.
static class	Offset.TimeBasedUUID A time-based UUID offset, backed by a UUID.

Field Summary

Fields

Modifier and Type	Field and Description
static Offset	NONE No offset.

Method Summary

Modifier and Type	Method and Description
static Offset	sequence(long value) Create a sequence offset.
static Offset	timeBasedUUID(UUID uuid) Create a time based UUID offset.

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NONE

public static final Offset NONE

No offset.

Method Detail

sequence

public static Offset sequence(long value)

Create a sequence offset.

Parameters:

value - The sequence number to create it from.

Returns:

The sequence offset.

timeBasedUUID

public static Offset timeBasedUUID(UUID uuid)

Create a time based UUID offset.

Parameters:

uuid - The timebased UUID to create it from.

Returns:

The time based UUID.