Package org.springframework.cloud.function.context.catalog

Class FunctionTypeUtils

java.lang.Object
org.springframework.cloud.function.context.catalog.FunctionTypeUtils
public final class FunctionTypeUtils extends Object
Set of utility operations to interrogate function definitions.
Since:
3.0
Author:
Oleg Zhurakousky, Andrey Shlykov

  • Method Details

    • functionType

      public static Type functionType(Type input, Type output)

    • consumerType

      public static Type consumerType(Type input)

    • supplierType

      public static Type supplierType(Type output)

    • isTypeCollection

      public static boolean isTypeCollection(Type type)
      Will return 'true' if the provided type is a Collection type. This also includes collections wrapped in Message. For example, If provided type is Message<List<Foo>> this operation will return 'true'.
      Parameters:
      type - type to interrogate
      Returns:
      'true' if this type represents a Collection. Otherwise 'false'.

    • isTypeMap

      public static boolean isTypeMap(Type type)

    • isTypeArray

      public static boolean isTypeArray(Type type)

    • isJsonNode

      public static boolean isJsonNode(Type type)

    • getGenericType

      public static Type getGenericType(Type type)
      A convenience method identical to getImmediateGenericType(Type, int) for cases when provided 'type' is Publisher or Message.
      Parameters:
      type - type to interrogate
      Returns:
      generic type if possible otherwise the same type as provided

    • getRawType

      public static Class<?> getRawType(Type type)
      Effectively converts Type which could be ParameterizedType to raw Class (no generics).
      Parameters:
      type - actual Type instance
      Returns:
      instance of Class as raw representation of the provided Type

    • discoverFunctionalMethod

      public static Method discoverFunctionalMethod(Class<?> pojoFunctionClass)
      Will attempt to discover functional methods on the class. It's applicable for POJOs as well as functional classes in `java.util.function` package. For the later the names of the methods are well known (`apply`, `accept` and `get`). For the former it will attempt to discover a single method following semantics described in (see FunctionalInterface)
      Parameters:
      pojoFunctionClass - the class to introspect
      Returns:
      functional method

    • discoverFunctionTypeFromClass

      public static Type discoverFunctionTypeFromClass(Class<?> functionalClass)

    • discoverFunctionTypeFromFunctionFactoryMethod

      public static Type discoverFunctionTypeFromFunctionFactoryMethod(Class<?> clazz, String methodName)
      Discovers the function Type based on the signature of a factory method. For example, given the following method Function<Message<Person>, Message<String>> uppercase() of class Foo - Type type = discoverFunctionTypeFromFunctionFactoryMethod(Foo.class, "uppercase");
      Parameters:
      clazz - instance of Class containing the factory method
      methodName - factory method name
      Returns:
      type of the function

    • discoverFunctionTypeFromFunctionFactoryMethod

      public static Type discoverFunctionTypeFromFunctionFactoryMethod(Method method)
      Discovers the function Type based on the signature of a factory method. For example, given the following method Function<Message<Person>, Message<String>> uppercase() of class Foo - Type type = discoverFunctionTypeFromFunctionFactoryMethod(Foo.class, "uppercase");
      Parameters:
      method - factory method
      Returns:
      type of the function

    • discoverFunctionTypeFromFunctionMethod

      public static Type discoverFunctionTypeFromFunctionMethod(Method functionMethod)
      Unlike discoverFunctionTypeFromFunctionFactoryMethod(Class, String), this method discovers function type from the well known method of Function(apply), Supplier(get) or Consumer(accept).
      Parameters:
      functionMethod - functional method
      Returns:
      type of the function

    • getInputCount

      public static int getInputCount(SimpleFunctionRegistry.FunctionInvocationWrapper function)

    • getOutputCount

      public static int getOutputCount(SimpleFunctionRegistry.FunctionInvocationWrapper function)

    • getComponentTypeOfInputType

      public static Type getComponentTypeOfInputType(Type functionType)
      In the event the input type is ParameterizedType this method returns its generic type.
      Parameters:
      functionType - instance of function type
      Returns:
      generic type or input type

    • getComponentTypeOfOutputType

      public static Type getComponentTypeOfOutputType(Type functionType)
      In the event the output type is ParameterizedType this method returns its generic type.
      Parameters:
      functionType - instance of function type
      Returns:
      generic type or output type

    • getInputType

      public static Type getInputType(Type functionType)
      Returns input type of function type that represents Function or Consumer.
      Parameters:
      functionType - the Type of Function or Consumer
      Returns:
      the input type as Type

    • discoverFunctionType

      public static Type discoverFunctionType(Object function, String functionName, org.springframework.context.support.GenericApplicationContext applicationContext)

    • discoverBeanDefinitionNameByQualifier

      public static String discoverBeanDefinitionNameByQualifier(org.springframework.beans.factory.ListableBeanFactory beanFactory, String qualifier)

    • getOutputType

      public static Type getOutputType(Type functionType)

    • getImmediateGenericType

      public static Type getImmediateGenericType(Type type, int index)

    • isPublisher

      public static boolean isPublisher(Type type)

    • isFlux

      public static boolean isFlux(Type type)

    • isCollectionOfMessage

      public static boolean isCollectionOfMessage(Type type)

    • isMessage

      public static boolean isMessage(Type type)

    • isOutputArray

      public static boolean isOutputArray(Type functionType)
      Determines if input argument to a Function is an array.
      Parameters:
      functionType - the function type
      Returns:
      true if input type is an array, otherwise false

    • isSupplier

      public static boolean isSupplier(Type type)

    • isFunction

      public static boolean isFunction(Type type)

    • isConsumer

      public static boolean isConsumer(Type type)

    • isMono

      public static boolean isMono(Type type)

    • isMultipleArgumentType

      public static boolean isMultipleArgumentType(Type type)