Module org.elasticsearch.compute
Package org.elasticsearch.compute.operator

Class Warnings

java.lang.Object
org.elasticsearch.compute.operator.Warnings
public class Warnings extends Object
Utilities to collect warnings for running an executor.

  • Field Details

    • NOOP_WARNINGS

      public static final Warnings NOOP_WARNINGS

  • Method Details

    • createWarnings

      public static Warnings createWarnings(DriverContext.WarningsMode warningsMode, WarningSourceLocation source)
      Create a new warnings object based on the given mode
      Parameters:
      warningsMode - The warnings collection strategy to use
      source - The source location information for warnings
      Returns:
      A warnings collector object

    • createWarningsTreatedAsFalse

      public static Warnings createWarningsTreatedAsFalse(DriverContext.WarningsMode warningsMode, WarningSourceLocation source)
      Create a new warnings object based on the given mode which warns that it treats the result as false.
      Parameters:
      warningsMode - The warnings collection strategy to use
      source - The source location information for warnings
      Returns:
      A warnings collector object

    • createOnlyWarnings

      public static Warnings createOnlyWarnings(DriverContext.WarningsMode warningsMode, WarningSourceLocation source)
      Create a new warnings object based on the given mode which warns that evaluation resulted in warnings.
      Parameters:
      warningsMode - The warnings collection strategy to use
      source - The source location information for warnings
      Returns:
      A warnings collector object

    • registerException

      public void registerException(Exception exception)

    • registerException

      public void registerException(Class<? extends Exception> exceptionClass, String message)
      Register an exception to be included in the warnings.

      This overload avoids the need to instantiate the exception, which can be expensive. Instead, it asks only the required pieces to build the warning.

    • registerWarning

      public void registerWarning(String message)
      Register a custom warning message (not tied to an exception). Even if the very same warning is registered multiple times, it will only be emitted once. This method therefore caches the emitted message and should not be called with non-constant messages!