org.apache.calcite.rel.hint

Interface HintOptionChecker

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface HintOptionChecker

A HintOptionChecker validates the options of a RelHint.

Every hint would have a validation when converting to a RelHint, the validation logic is: i) checks whether the hint was already registered; ii) use the registered HintOptionChecker to check the hint options.

In HintStrategyTable the option checker is used for hints registration as an optional parameter.

See Also:

HintStrategyTable.validateHint(org.apache.calcite.rel.hint.RelHint)

Method Summary

Modifier and Type	Method and Description
boolean	checkOptions(RelHint hint, Litmus errorHandler) Checks if the given hint is valid.

Method Detail

checkOptions

boolean checkOptions(RelHint hint,
                     Litmus errorHandler)

Checks if the given hint is valid.

Always use the Litmus.check(boolean, String, Object...) to do the check. The default behavior is to log warnings for any hint error.

Parameters:

hint - The hint to check

errorHandler - The error handler

Returns:

True if the check passes