Package com.couchbase.client.core.api.kv

Class CoreExpiry

java.lang.Object

com.couchbase.client.core.api.kv.CoreExpiry

@Internal
public final class CoreExpiry
extends Object

A relative or absolute expiry.

Exactly one of relative or absolute is non-null, except for the special NONE instance, which has null for both.

Field Summary

Fields

Modifier and Type	Field	Description
static final Instant	EARLIEST_VALID_EXPIRY_INSTANT	Earliest expiry instant that can be represented in the Memcached binary protocol.
static final Instant	LATEST_VALID_EXPIRY_INSTANT	Latest expiry instant that can be represented in the Memcached binary protocol.
static final CoreExpiry	NONE	A "null object" that represents the absence of an expiry.

Method Summary

Modifier and Type	Method	Description
Instant	absolute()
boolean	isNone()
static CoreExpiry	of(Duration duration)	Returns NONE if the duration is zero, otherwise a relative CoreExpiry with this duration.
static CoreExpiry	of(Instant instant)	Returns NONE if the instant's epoch second is zero, otherwise an absolute CoreExpiry with this instant.
Duration	relative()
String	toString()
void	when(Consumer<Instant> ifAbsolute, Consumer<Duration> ifRelative, Runnable ifNone)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

LATEST_VALID_EXPIRY_INSTANT

public static final Instant LATEST_VALID_EXPIRY_INSTANT

Latest expiry instant that can be represented in the Memcached binary protocol.

The server interprets the Memcached protocol's 32-bit expiry field as an unsigned integer. This means the maximum value is 4294967295 seconds, which corresponds to 2106-02-07T06:28:15Z.

EARLIEST_VALID_EXPIRY_INSTANT

public static final Instant EARLIEST_VALID_EXPIRY_INSTANT

Earliest expiry instant that can be represented in the Memcached binary protocol.

A negative instant (before the epoch) could be misinterpreted as in the future. An instant within 30 days after the epoch would be misinterpreted as a relative expiry.

Fortunately, setting a document's expiry this far in the past is almost certainly a programming error, so it's fine for the SDK to throw an exception.

NONE

public static final CoreExpiry NONE

A "null object" that represents the absence of an expiry.

Its isNone() method returns true. Its absolute() and relative methods both return null.

Method Details

of

public static CoreExpiry of(Duration duration)

Returns NONE if the duration is zero, otherwise a relative CoreExpiry with this duration.

Throws:

InvalidArgumentException - if duration is non-zero and less than 1 second.

of

public static CoreExpiry of(Instant instant)

Returns NONE if the instant's epoch second is zero, otherwise an absolute CoreExpiry with this instant.

Throws:

InvalidArgumentException - if instant is non-zero and outside the valid range.

See Also:

• EARLIEST_VALID_EXPIRY_INSTANT
• LATEST_VALID_EXPIRY_INSTANT

isNone

public boolean isNone()

relative

@Nullable
public Duration relative()

absolute

@Nullable
public Instant absolute()

when

public void when(Consumer<Instant> ifAbsolute,
 Consumer<Duration> ifRelative,
 Runnable ifNone)

toString

public String toString()

Overrides:

toString in class Object