Package dev.frostlake.functions.scalar.file

Class TryToFile

java.lang.Object
dev.frostlake.functions.BuiltInFunction
dev.frostlake.functions.scalar.file.TryToFile
public class TryToFile extends BuiltInFunction
TRY_TO_FILE(...) — ToFile with every failure turned into NULL.

Live-verified: TRY_TO_FILE('@sse/missing.txt') is NULL where TO_FILE of the same path errors, and an invalid metadata object (an unknown field, a missing required field, a LAST_MODIFIED that is not an RFC-1123 date, or one carrying neither a stage-and-path nor a URL) is NULL where TO_FILE raises the corresponding "Invalid file metadata…" error. Valid input gives the identical descriptor.

  • Constructor Details

    • TryToFile

      public TryToFile()

    • TryToFile

      public TryToFile(StageFileLocator locator)

  • 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

    • 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