Reflect (scalecube-services-api 2.10.23 API)

java.lang.Object
- io.scalecube.services.Reflect

```
public class Reflect
extends Object
```

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static CommunicationMode`	`communicationMode(Method method)` This method is used to get catual `CommunicationMode` os service method.
`static boolean`	`isRequestTypeServiceMessage(Method method)` Util function to check if the first parameter of method is ServiceMessage.
`static boolean`	`isReturnTypeServiceMessage(Method method)` Util function to check if return type of method is ServiceMessage.
`static boolean`	`isSecured(Method method)`
`static boolean`	`isService(Class<?> type)`
`static String`	`methodName(Method method)`
`static Map<Method,MethodInfo>`	`methodsInfo(Class<?> serviceInterface)` Parse `serviceInterface` class and puts available methods annotated by `ServiceMethod` annotation to `Method` -> `MethodInfo` mapping.
`static Type`	`parameterizedRequestType(Method method)` Util function that returns the parameterized of the request Type of a given object.
`static Type`	`parameterizedReturnType(Method method)` extract parameterized return value of a method.
`static Type`	`parameterizedType(Object object)` Util function that returns the parameterizedType of a given object.
`static String`	`qualifier(Class<?> serviceInterface, Method method)` Handy method to get qualifier String from service's interface and method.
`static Class<?>`	`requestType(Method method)` Util function returns the the Type of method parameter [0] or Void.Type in case 0 parameters.
`static Stream<Class<?>>`	`serviceInterfaces(Object serviceObject)` Util function to get service interfaces collections from service instance.
`static Map<String,Method>`	`serviceMethods(Class<?> serviceInterface)` Util function to get service Method map from service api.
`static Map<String,String>`	`serviceMethodTags(Method serviceMethod)` Util function to extract service tags from service method api.
`static String`	`serviceName(Class<?> serviceInterface)` Util function to extract service name from service api.
`static Map<String,String>`	`serviceTags(Class<?> serviceInterface)` Util function to extract service tags from service api.
`static void`	`validateMethodOrThrow(Method method)` Util function to perform basic validation of service message request.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - parameterizedReturnType
```
public static Type parameterizedReturnType(Method method)
```
    extract parameterized return value of a method.
    
    Parameters:
    
    method - to extract type from.
    
    Returns:
    
    the generic type of the return value or object.
  - isReturnTypeServiceMessage
```
public static boolean isReturnTypeServiceMessage(Method method)
```
    Util function to check if return type of method is ServiceMessage.
    
    Parameters:
    
    method - method to inspect
    
    Returns:
    
    true if return type of method is ServiceMessage, otherwise false
  - requestType
```
public static Class<?> requestType(Method method)
```
    Util function returns the the Type of method parameter [0] or Void.Type in case 0 parameters. in case the method is annotated with @RequestType this type will always be chosen. if the parameter is generic eg. <String> the actual type will be used. in case there is no annotation and the type is not generic then return the actual type. in case method accepts service message and no RequestType annotation is present then return Object.class
    
    Parameters:
    
    method - in inspection.
    
    Returns:
    
    type of parameter [0] or void
  - isRequestTypeServiceMessage
```
public static boolean isRequestTypeServiceMessage(Method method)
```
    Util function to check if the first parameter of method is ServiceMessage.
    
    Parameters:
    
    method - method to inspect
    
    Returns:
    
    true if the first parameter of method is ServiceMessage, otherwise false
  - parameterizedType
```
public static Type parameterizedType(Object object)
```
    Util function that returns the parameterizedType of a given object.
    
    Parameters:
    
    object - to inspect
    
    Returns:
    
    the parameterized Type of a given object or Object class if unknown.
  - methodsInfo
```
public static Map<Method,MethodInfo> methodsInfo(Class<?> serviceInterface)
```
    Parse serviceInterface class and puts available methods annotated by ServiceMethod annotation to Method -> MethodInfo mapping.
    
    Parameters:
    
    serviceInterface - - service interface to be parsed.
    
    Returns:
    
    - mapping form available service methods of the serviceInterface to their descriptions
  - parameterizedRequestType
```
public static Type parameterizedRequestType(Method method)
```
    Util function that returns the parameterized of the request Type of a given object.
    
    Returns:
    
    the parameterized Type of a given object or Object class if unknown.
  - serviceName
```
public static String serviceName(Class<?> serviceInterface)
```
    Util function to extract service name from service api.
    
    Parameters:
    
    serviceInterface - with @Service annotation.
    
    Returns:
    
    service name.
  - serviceTags
```
public static Map<String,String> serviceTags(Class<?> serviceInterface)
```
    Util function to extract service tags from service api.
    
    Parameters:
    
    serviceInterface - with @Service annotation.
    
    Returns:
    
    service tags
  - serviceMethodTags
```
public static Map<String,String> serviceMethodTags(Method serviceMethod)
```
    Util function to extract service tags from service method api.
    
    Parameters:
    
    serviceMethod - with @ServiceMethod annotation.
    
    Returns:
    
    service tags
  - serviceMethods
```
public static Map<String,Method> serviceMethods(Class<?> serviceInterface)
```
    Util function to get service Method map from service api.
    
    Parameters:
    
    serviceInterface - with @Service annotation.
    
    Returns:
    
    service name.
  - serviceInterfaces
```
public static Stream<Class<?>> serviceInterfaces(Object serviceObject)
```
    Util function to get service interfaces collections from service instance.
    
    Parameters:
    
    serviceObject - with extends service interface with @Service annotation.
    
    Returns:
    
    service interface class.
  - methodName
```
public static String methodName(Method method)
```
  - qualifier
```
public static String qualifier(Class<?> serviceInterface,
                               Method method)
```
    Handy method to get qualifier String from service's interface and method.
    
    Parameters:
    
    serviceInterface - service interface to get qualifier for
    
    method - service's method to get qualifier for
    
    Returns:
    
    qualifier string
  - validateMethodOrThrow
```
public static void validateMethodOrThrow(Method method)
```
    Util function to perform basic validation of service message request.
    
    Parameters:
    
    method - service method.
  - communicationMode
```
public static CommunicationMode communicationMode(Method method)
```
    This method is used to get catual CommunicationMode os service method.
    The following modes are supported:
    - CommunicationMode.REQUEST_CHANNEL - service has at least one parameter,and the first parameter is either of type return type Flux or Publisher;
    - CommunicationMode.REQUEST_STREAM - service's return type is Flux, and parameter is not Flux;
    - CommunicationMode.REQUEST_RESPONSE - service's return type is Mono;
    - CommunicationMode.FIRE_AND_FORGET - service returns void;
    Parameters:
    
    method - - Service method to be analyzed.
    
    Returns:
    
    - CommunicationMode of service method. If method does not correspond to any of supported modes, throws IllegalArgumentException
  - isService
```
public static boolean isService(Class<?> type)
```
  - isSecured
```
public static boolean isSecured(Method method)
```

Class Reflect

Method Summary

Methods inherited from class java.lang.Object

Method Detail

parameterizedReturnType

isReturnTypeServiceMessage

requestType

isRequestTypeServiceMessage

parameterizedType

methodsInfo

parameterizedRequestType

serviceName

serviceTags

serviceMethodTags

serviceMethods

serviceInterfaces

methodName

qualifier

validateMethodOrThrow

communicationMode

isService

isSecured