Class SqlParameter

    • Method Detail

      • name

        public final String name()

        The name of the parameter.

        Returns:
        The name of the parameter.
      • value

        public final Field value()

        The value of the parameter.

        Returns:
        The value of the parameter.
      • typeHint

        public final TypeHint typeHint()

        A hint that specifies the correct object type for data type mapping. Possible values are as follows:

        • DATE - The corresponding String parameter value is sent as an object of DATE type to the database. The accepted format is YYYY-MM-DD.

        • DECIMAL - The corresponding String parameter value is sent as an object of DECIMAL type to the database.

        • JSON - The corresponding String parameter value is sent as an object of JSON type to the database.

        • TIME - The corresponding String parameter value is sent as an object of TIME type to the database. The accepted format is HH:MM:SS[.FFF].

        • TIMESTAMP - The corresponding String parameter value is sent as an object of TIMESTAMP type to the database. The accepted format is YYYY-MM-DD HH:MM:SS[.FFF].

        • UUID - The corresponding String parameter value is sent as an object of UUID type to the database.

        If the service returns an enum value that is not available in the current SDK version, typeHint will return TypeHint.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeHintAsString().

        Returns:
        A hint that specifies the correct object type for data type mapping. Possible values are as follows:

        • DATE - The corresponding String parameter value is sent as an object of DATE type to the database. The accepted format is YYYY-MM-DD.

        • DECIMAL - The corresponding String parameter value is sent as an object of DECIMAL type to the database.

        • JSON - The corresponding String parameter value is sent as an object of JSON type to the database.

        • TIME - The corresponding String parameter value is sent as an object of TIME type to the database. The accepted format is HH:MM:SS[.FFF].

        • TIMESTAMP - The corresponding String parameter value is sent as an object of TIMESTAMP type to the database. The accepted format is YYYY-MM-DD HH:MM:SS[.FFF].

        • UUID - The corresponding String parameter value is sent as an object of UUID type to the database.

        See Also:
        TypeHint
      • typeHintAsString

        public final String typeHintAsString()

        A hint that specifies the correct object type for data type mapping. Possible values are as follows:

        • DATE - The corresponding String parameter value is sent as an object of DATE type to the database. The accepted format is YYYY-MM-DD.

        • DECIMAL - The corresponding String parameter value is sent as an object of DECIMAL type to the database.

        • JSON - The corresponding String parameter value is sent as an object of JSON type to the database.

        • TIME - The corresponding String parameter value is sent as an object of TIME type to the database. The accepted format is HH:MM:SS[.FFF].

        • TIMESTAMP - The corresponding String parameter value is sent as an object of TIMESTAMP type to the database. The accepted format is YYYY-MM-DD HH:MM:SS[.FFF].

        • UUID - The corresponding String parameter value is sent as an object of UUID type to the database.

        If the service returns an enum value that is not available in the current SDK version, typeHint will return TypeHint.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeHintAsString().

        Returns:
        A hint that specifies the correct object type for data type mapping. Possible values are as follows:

        • DATE - The corresponding String parameter value is sent as an object of DATE type to the database. The accepted format is YYYY-MM-DD.

        • DECIMAL - The corresponding String parameter value is sent as an object of DECIMAL type to the database.

        • JSON - The corresponding String parameter value is sent as an object of JSON type to the database.

        • TIME - The corresponding String parameter value is sent as an object of TIME type to the database. The accepted format is HH:MM:SS[.FFF].

        • TIMESTAMP - The corresponding String parameter value is sent as an object of TIMESTAMP type to the database. The accepted format is YYYY-MM-DD HH:MM:SS[.FFF].

        • UUID - The corresponding String parameter value is sent as an object of UUID type to the database.

        See Also:
        TypeHint
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object
      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                                      Class<T> clazz)