redis.clients.jedis.resps

Enum StreamEntryDeletionResult

java.lang.Object

java.lang.Enum<StreamEntryDeletionResult>

redis.clients.jedis.resps.StreamEntryDeletionResult

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<StreamEntryDeletionResult>

public enum StreamEntryDeletionResult
extends java.lang.Enum<StreamEntryDeletionResult>

Represents the result of a stream entry deletion operation for XDELEX and XACKDEL commands.

• NOT_FOUND (-1): ID doesn't exist in stream
• DELETED (1): Entry was deleted/acknowledged and deleted
• NOT_DELETED_UNACKNOWLEDGED_OR_STILL_REFERENCED (2): Entry wasn't deleted.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DELETED The entry was successfully deleted/acknowledged and deleted.
NOT_DELETED_UNACKNOWLEDGED_OR_STILL_REFERENCED The entry was not deleted due to one of the following reasons: For XDELEX: The entry was not acknowledged by any consumer group For XACKDEL: The entry still has pending references in other consumer groups
NOT_FOUND The stream entry ID doesn't exist in the stream.

Method Summary

Modifier and Type	Method and Description
static StreamEntryDeletionResult	fromCode(int code) Creates a StreamEntryDeletionResult from the numeric code returned by Redis.
static StreamEntryDeletionResult	fromLong(java.lang.Long value) Creates a StreamEntryDeletionResult from a Long value returned by Redis.
int	getCode() Gets the numeric code returned by Redis for this result.
java.lang.String	toString()
static StreamEntryDeletionResult	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static StreamEntryDeletionResult[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NOT_FOUND

public static final StreamEntryDeletionResult NOT_FOUND

The stream entry ID doesn't exist in the stream.

Returned when trying to delete/acknowledge a non-existent entry.

DELETED

public static final StreamEntryDeletionResult DELETED

The entry was successfully deleted/acknowledged and deleted.

This is the typical successful case.

NOT_DELETED_UNACKNOWLEDGED_OR_STILL_REFERENCED

public static final StreamEntryDeletionResult NOT_DELETED_UNACKNOWLEDGED_OR_STILL_REFERENCED

The entry was not deleted due to one of the following reasons:

• For XDELEX: The entry was not acknowledged by any consumer group
• For XACKDEL: The entry still has pending references in other consumer groups

Method Detail

values

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

Returns:

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

valueOf

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

getCode

public int getCode()

Gets the numeric code returned by Redis for this result.

Returns:

the numeric code (-1, 1, or 2)

fromCode

public static StreamEntryDeletionResult fromCode(int code)

Creates a StreamEntryDeletionResult from the numeric code returned by Redis.

Parameters:

code - the numeric code from Redis

Returns:

the corresponding StreamEntryDeletionResult

Throws:

java.lang.IllegalArgumentException - if the code is not recognized

fromLong

public static StreamEntryDeletionResult fromLong(java.lang.Long value)

Creates a StreamEntryDeletionResult from a Long value returned by Redis.

Parameters:

value - the Long value from Redis

Returns:

the corresponding StreamEntryDeletionResult

Throws:

java.lang.IllegalArgumentException - if the value is null or not recognized

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<StreamEntryDeletionResult>