Package dev.frostlake.functions.scalar.encoding

Class HexEncode

java.lang.Object
dev.frostlake.functions.BuiltInFunction
dev.frostlake.functions.scalar.encoding.HexEncode
public class HexEncode extends BuiltInFunction
HEX_ENCODE(expr [, case]) — the hex encoding of the input's bytes, uppercase by default.

A BINARY argument contributes its OWN bytes: HEX_ENCODE(TO_BINARY('48454C','HEX')) is 48454C. Encoding toString() instead would encode the hex RENDERING and yield 343834353443 — valid-looking hex, entirely wrong.

The optional second argument chooses the case: 1 (the default) upper, 0 lower. It takes no other value — the account answers "Numeric value is out of range, error: 2" at ROW time, not a compile-time refusal.

  • Constructor Details

    • HexEncode

      public HexEncode()

  • Method Details

    • evaluate

      public Object evaluate(List<Object> args)
      Description copied from class: BuiltInFunction
      Computes the function's result over its already-evaluated argument values. A SQL NULL argument arrives as Java null, and returning null makes the SQL result NULL.
      Specified by:
      evaluate in class BuiltInFunction
      Parameters:
      args - the argument values, in call order
      Returns:
      the function's value for these arguments, or null for SQL NULL

    • vectorRejection

      public SemiStructuredRejection vectorRejection(int position)
      A VECTOR is refused by its argument type, in every position (live-verified).
      Overrides:
      vectorRejection in class BuiltInFunction
      Parameters:
      position - the zero-based argument position being asked about
      Returns:
      the refusal this position gives a VECTOR value; by default none

    • getMinArgCount

      public int getMinArgCount()
      Description copied from class: BuiltInFunction
      The fewest arguments a call to this function may pass; fewer is an argument-count error.
      Specified by:
      getMinArgCount in class BuiltInFunction
      Returns:
      the minimum accepted argument count

    • getMaxArgCount

      public int getMaxArgCount()
      Description copied from class: BuiltInFunction
      The most arguments a call to this function may pass; Integer.MAX_VALUE marks a variadic function (see BuiltInFunction.isVariadic()).
      Specified by:
      getMaxArgCount in class BuiltInFunction
      Returns:
      the maximum accepted argument count