Package com.github.marschall.storedprocedureproxy.annotations

Annotation Type OutParameter

  • @Documented
@Retention(RUNTIME)
@Target(METHOD)
public @interface OutParameter
    Signals that the procedure uses an out parameter rather than a return value or result set.

    Applied to a method means that the return value should be retrieved using an out parameter. In addition allows to provide additional information about the out parameter.

    Causes a call string to be generated in the form of {@code "{call function_name(?)}" instead of "{ ? = call function_name()}"} where one of the function arguments is an out parameter.

    See Also:
    ReturnValue, InOutParameter, Out Parameter Result Extraction

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      int index
      Defines the index of the out parameter.
      String name
      Defines the name of the out parameter.
      int type
      Defines the SQL type of the out parameter.
      String typeName
      If the out parameter is a a user defined type like a named array types then this method denotes the type name.

    • Element Detail

      • type

        int type
        Defines the SQL type of the out parameter. If nothing is specified the default from TypeMapper is used.
        Returns:
        the out parameter SQL type, can be a vendor type
        See Also:
        Types
        Default:
        -2147483648

      • index

        int index
        Defines the index of the out parameter. If not specified the out parameter is assumed to be the last parameter.

        If the out parameter isn't the last parameter you have to provide the index of the out parameter.

        Returns:
        the 1 based index of the out parameter
        Default:
        -1