Package org.springframework.data.gemfire.function

Class GemfireFunctionUtils

java.lang.Object

org.springframework.data.gemfire.function.GemfireFunctionUtils

public abstract class GemfireFunctionUtils
extends Object

Utility class for registering a POJO as a GemFire/Geode Function.

Since:

1.2.0

Author:

David Turanski, John Blum

See Also:

• Function
• FunctionService
• GemfireFunction

Constructor Summary

Constructors

Constructor	Description
GemfireFunctionUtils()

Method Summary

Modifier and Type	Method	Description
static int	getAnnotationParameterPosition(Method method, Class<?> targetAnnotationType, Class<?>[] requiredTypes)	Determine the order position of a an annotated method parameter
static Optional<String>	getGemfireFunctionId(Method method)	Null-safe operation used to determine the GemFire/Geode Function.getId() Function ID} of a given GemfireFunction annotated POJO Method.
static boolean	isGemfireFunction(Method method)	Determines whether the given Method is a POJO, GemfireFunction annotated Method.
static boolean	isMatchingGemfireFunction(Method method, String functionId)	Determines whether the given Method is a POJO, GemfireFunction annotated Method having an ID matching the given functionId.
static void	registerFunctionForPojoMethod(Class<?> type, String functionId)	Bind a method with the given Function ID on an object of the given type as a Function and register it with the FunctionService.
static void	registerFunctionForPojoMethod(Object target, Method method, boolean overwrite)	Binds the given method on the given target as a Function and registers it with the FunctionService.
static void	registerFunctionForPojoMethod(Object target, Method method, AnnotationAttributes gemfireFunctionAttributes, boolean overwrite)	Wrap the target object and method in a GemFire/Geode Function and register the Function with the FunctionService.
static void	registerFunctionForPojoMethod(Object target, String functionId)	Bind a method with the given Function ID on the given target as a Function and register it with the FunctionService.

Methods inherited from class java.lang.Object

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

Constructor Details

GemfireFunctionUtils

public GemfireFunctionUtils()

Method Details

isGemfireFunction

public static boolean isGemfireFunction(Method method)

Determines whether the given Method is a POJO, GemfireFunction annotated Method.

Parameters:

method - Method to evaluate.

Returns:

a boolean value indicating whether the Method on a POJO represents a SDG GemfireFunction.

See Also:

• GemfireFunction
• Method

isMatchingGemfireFunction

public static boolean isMatchingGemfireFunction(Method method,
 String functionId)

Determines whether the given Method is a POJO, GemfireFunction annotated Method having an ID matching the given functionId.

Parameters:

method - Method to evaluate.

functionId - String containing the ID to match.

Returns:

a boolean indicating whether the given Method is a POJO, GemfireFunction annotated Method with the given functionId.

See Also:

• getGemfireFunctionId(Method)
• Method

getGemfireFunctionId

public static Optional<String> getGemfireFunctionId(Method method)

Null-safe operation used to determine the GemFire/Geode Function.getId() Function ID} of a given GemfireFunction annotated POJO Method. If the Method is not null and annotated with GemfireFunction then this method tries to determine the Function.getId() from the GemfireFunction.id() attribute. If the GemfireFunction.id() attribute was not explicitly set, then the Method.getName() is returned as the Function ID.

Parameters:

method - GemfireFunction annotated POJO Method containing the implementation of the GemFire/Geode Function.

Returns:

the GemFire/Geode Function ID of the given Method, or an empty Optional if the Method is not a GemFire/Geode Function.

See Also:

• GemfireFunction
• Method
• isGemfireFunction(Method)

registerFunctionForPojoMethod

public static void registerFunctionForPojoMethod(Class<?> type,
 String functionId)

Bind a method with the given Function ID on an object of the given type as a Function and register it with the FunctionService.

Parameters:

type - target type to evaluate; must not be null.

functionId - String containing the Function.getId() identifying the Method on the target type to bind as a Function.

Throws:

IllegalArgumentException - if type is null.

See Also:

• registerFunctionForPojoMethod(Object, Method, AnnotationAttributes, boolean)
• isMatchingGemfireFunction(Method, String)

registerFunctionForPojoMethod

public static void registerFunctionForPojoMethod(Object target,
 String functionId)

Bind a method with the given Function ID on the given target as a Function and register it with the FunctionService.

Parameters:

target - target object to evaluate; must not be null.

functionId - String containing the Function.getId() identifying the Method on the target object to bind as a Function.

Throws:

IllegalArgumentException - if target is null.

See Also:

• registerFunctionForPojoMethod(Object, Method, AnnotationAttributes, boolean)
• isMatchingGemfireFunction(Method, String)

registerFunctionForPojoMethod

public static void registerFunctionForPojoMethod(Object target,
 Method method,
 boolean overwrite)

Binds the given method on the given target as a Function and registers it with the FunctionService.

Parameters:

target - target object to evaluate; must not be null.

method - Method on target bound as a Function.

overwrite - if true, will replace any existing Function having the same ID.

Throws:

IllegalArgumentException - if target is null or the given Method is not a GemfireFunction.

See Also:

• registerFunctionForPojoMethod(Object, Method, AnnotationAttributes, boolean)
• isGemfireFunction(Method)

registerFunctionForPojoMethod

public static void registerFunctionForPojoMethod(Object target,
 Method method,
 AnnotationAttributes gemfireFunctionAttributes,
 boolean overwrite)

Wrap the target object and method in a GemFire/Geode Function and register the Function with the FunctionService.

Parameters:

target - target object.

method - Method bound to a Function.

gemfireFunctionAttributes - GemfireFunction annotation attributes.

overwrite - if true, will replace any existing Function having the same ID.

getAnnotationParameterPosition

public static int getAnnotationParameterPosition(Method method,
 Class<?> targetAnnotationType,
 Class<?>[] requiredTypes)

Determine the order position of a an annotated method parameter

Parameters:

method - the Method instance

targetAnnotationType - the annotation

requiredTypes - an array of valid parameter types for the annotation

Returns:

the parameter position or -1 if the annotated parameter is not found