org.apache.calcite.util

Interface Litmus

All Known Implementing Classes:

HintStrategyTable.HintErrorLogger

public interface Litmus

Callback to be called when a test for validity succeeds or fails.

Field Summary

Fields

Modifier and Type	Field and Description
static Litmus	IGNORE Implementation of Litmus that returns a status code but does not throw.
static Litmus	THROW Implementation of Litmus that throws an AssertionError on failure.

Method Summary

Modifier and Type	Method and Description
boolean	check(boolean condition, @Nullable String message, Object... args) Checks a condition.
boolean	fail(@Nullable String message, Object... args) Called when test fails.
boolean	succeed() Called when test succeeds.

Field Detail

THROW

static final Litmus THROW

Implementation of Litmus that throws an AssertionError on failure.

IGNORE

static final Litmus IGNORE

Implementation of Litmus that returns a status code but does not throw.

Method Detail

fail

boolean fail(@Nullable String message,
             Object... args)

Called when test fails. Returns false or throws.

Parameters:

message - Message

args - Arguments

succeed

boolean succeed()

Called when test succeeds. Returns true.

check

boolean check(boolean condition,
              @Nullable String message,
              Object... args)

Checks a condition.

If the condition is true, calls succeed(); if the condition is false, calls fail(java.lang.String, java.lang.Object...), converting info into a string message.