Module lettuce.core

Package io.lettuce.core.dynamic

Class DeclaredCommandMethod

java.lang.Object

io.lettuce.core.dynamic.DeclaredCommandMethod

All Implemented Interfaces:

CommandMethod

public class DeclaredCommandMethod
extends Object
implements CommandMethod

Abstraction of a method that is designated to execute a Redis command method. Enriches the standard Method interface with specific information that is necessary to construct RedisCommand for the method.

Since:

5.0

Author:

Mark Paluch

Method Summary

Modifier and Type	Method	Description
static CommandMethod	create(Method method)	Create a new DeclaredCommandMethod given a Method.
boolean	equals(Object o)
ResolvableType	getActualReturnType()
<A extends Annotation> A	getAnnotation(Class<A> annotationClass)	Lookup a method annotation.
Method	getMethod()
String	getName()
Parameters<? extends Parameter>	getParameters()
ResolvableType	getReturnType()
boolean	hasAnnotation(Class<? extends Annotation> annotationClass)
int	hashCode()
boolean	isBatchExecution()
boolean	isFutureExecution()
boolean	isReactiveExecution()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

create

public static CommandMethod create(Method method)

Create a new DeclaredCommandMethod given a Method.

Parameters:

method - must not be null.

getParameters

public Parameters<? extends Parameter> getParameters()

Specified by:

getParameters in interface CommandMethod

Returns:

the method Parameters.

getMethod

public Method getMethod()

Specified by:

getMethod in interface CommandMethod

Returns:

the Method.

getReturnType

public ResolvableType getReturnType()

Specified by:

getReturnType in interface CommandMethod

Returns:

declared Method return TypeInformation.

getActualReturnType

public ResolvableType getActualReturnType()

Specified by:

getActualReturnType in interface CommandMethod

Returns:

the actual Method return TypeInformation after unwrapping.

getAnnotation

public <A extends Annotation> A getAnnotation(Class<A> annotationClass)

Lookup a method annotation.

Specified by:

getAnnotation in interface CommandMethod

Parameters:

annotationClass - the annotation class.

Returns:

the annotation object or null if not found.

hasAnnotation

public boolean hasAnnotation(Class<? extends Annotation> annotationClass)

Specified by:

hasAnnotation in interface CommandMethod

Parameters:

annotationClass - the annotation class.

Returns:

true if the method is annotated with annotationClass.

getName

public String getName()

Specified by:

getName in interface CommandMethod

Returns:

the method name.

isFutureExecution

public boolean isFutureExecution()

Specified by:

isFutureExecution in interface CommandMethod

Returns:

true if the method uses asynchronous execution declaring Future as result type.

isReactiveExecution

public boolean isReactiveExecution()

Specified by:

isReactiveExecution in interface CommandMethod

Returns:

true if the method uses reactive execution declaring Publisher as result type.

isBatchExecution

public boolean isBatchExecution()

Specified by:

isBatchExecution in interface CommandMethod

Returns:

true if the method defines a CommandBatching argument.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object