redis.clients.jedis.args

Enum ExpiryOption

java.lang.Object

java.lang.Enum<ExpiryOption>

redis.clients.jedis.args.ExpiryOption

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ExpiryOption>, Rawable

public enum ExpiryOption
extends java.lang.Enum<ExpiryOption>
implements Rawable

Enumeration of setting expiration.

Enum Constant Summary

Enum Constants

Enum Constant and Description
GT Set expiry only when the new expiry is greater than the existing one.
LT Set expiry only when the new expiry is less than the existing one.
NX Set expiry only when the key has no expiry.
XX Set expiry only when the key has an existing expiry.

Method Summary

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

equals, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface redis.clients.jedis.args.Rawable

equals, hashCode

Enum Constant Detail

NX

public static final ExpiryOption NX

Set expiry only when the key has no expiry.

XX

public static final ExpiryOption XX

Set expiry only when the key has an existing expiry.

GT

public static final ExpiryOption GT

Set expiry only when the new expiry is greater than the existing one.

LT

public static final ExpiryOption LT

Set expiry only when the new expiry is less than the existing one.

Method Detail

values

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

Returns:

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

valueOf

public static ExpiryOption 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

getRaw

public byte[] getRaw()

Description copied from interface: Rawable

Get byte array.

Specified by:

getRaw in interface Rawable

Returns:

binary