Enum SqlParamDirection

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<SqlParamDirection>

    public enum SqlParamDirection
    extends java.lang.Enum<SqlParamDirection>
    Sets the SQL param direction.
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      Input
      Used for Input variables.
      InputOutput
      The parameter can perform both input and output.
      Output
      Used for Output variable and value will be returned to calling environment.
      ReturnValue
      The parameter represents a return value from an operation such as a stored procedure, built-in function, or user-defined function.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static SqlParamDirection forValue​(int value)
      retreives the enum constant of the specified value, if exists.
      int getValue()
      Order is important in enums.By using getValue() method, each enum constant index can be found, just like array index.
      static SqlParamDirection valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static SqlParamDirection[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • Input

        public static final SqlParamDirection Input
        Used for Input variables. The value will be passed from calling environment. This is the default.
      • Output

        public static final SqlParamDirection Output
        Used for Output variable and value will be returned to calling environment.
      • InputOutput

        public static final SqlParamDirection InputOutput
        The parameter can perform both input and output.
      • ReturnValue

        public static final SqlParamDirection ReturnValue
        The parameter represents a return value from an operation such as a stored procedure, built-in function, or user-defined function.
    • Method Detail

      • values

        public static SqlParamDirection[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (SqlParamDirection c : SqlParamDirection.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static SqlParamDirection valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null
      • forValue

        public static SqlParamDirection forValue​(int value)
        retreives the enum constant of the specified value, if exists.
        Parameters:
        value - enum constant index
        Returns:
        enum constant
      • getValue

        public int getValue()
        Order is important in enums.By using getValue() method, each enum constant index can be found, just like array index.
        Returns:
        enum constant index