Package com.couchbase.client.java.kv

Class Expiry

java.lang.Object

com.couchbase.client.java.kv.Expiry

@Internal
public class Expiry
extends Object

Method Summary

Modifier and Type	Method	Description
static Expiry	absolute(Instant expiry)
long	encode()
long	encode(EventBus eventBus)	Deprecated. Please use encode() instead.
static Expiry	none()
static Expiry	relative(Duration expiry)
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

none

public static Expiry none()

relative

public static Expiry relative(Duration expiry)

Throws:

InvalidArgumentException - if the Duration is non-zero and less than 1 second, or greater than 18,250 days (~50 years)

absolute

public static Expiry absolute(Instant expiry)

Throws:

InvalidArgumentException - if the Instant is after 2106-02-07T06:28:15Z, or is non-zero and before 1970-02-01T00:00:00Z

encode

public long encode()

Throws:

InvalidArgumentException - if the expiry occurs after 2106-02-07T06:28:15Z

encode

@Deprecated
public long encode(EventBus eventBus)

Deprecated.

Please use encode() instead.

This method remains as a courtesy to users brave enough to rely on Couchbase internal API. It is scheduled for removal in a future version of the SDK.

toString

public String toString()

Overrides:

toString in class Object