Module lettuce.core

Package io.lettuce.core.dynamic.domain

Class Timeout

java.lang.Object

io.lettuce.core.dynamic.domain.Timeout

public class Timeout
extends Object

Timeout value object to represent a timeout value with its TimeUnit.

Since:

5.0

Author:

Mark Paluch

See Also:

Command

Method Summary

Modifier and Type	Method	Description
static Timeout	create(long timeout, TimeUnit timeUnit)	Create a Timeout.
static Timeout	create(Duration timeout)	Create a Timeout.
Duration	getTimeout()

Methods inherited from class java.lang.Object

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

Method Details

create

public static Timeout create(Duration timeout)

Create a Timeout.

Parameters:

timeout - the timeout value, must be non-negative.

Returns:

the Timeout.

create

public static Timeout create(long timeout,
TimeUnit timeUnit)

Create a Timeout.

Parameters:

timeout - the timeout value, must be non-negative.

timeUnit - the associated TimeUnit, must not be null.

Returns:

the Timeout.

getTimeout

public Duration getTimeout()

Returns:

the timeout value.