org.eclipse.swtbot.swt.finder.waits
Interface ICondition

All Known Implementing Classes:

DefaultCondition, WaitForEditor, WaitForObjectCondition, WaitForView

public interface ICondition

Since:

1.2

Version:

$Id$

Author:

Ketan Padegaonkar <KetanPadegaonkar [at] gmail [dot] com>

See Also:

Conditions

Method Summary

String	getFailureMessage() Gets the failure message when a test fails (returns false).
void	init(SWTBot bot) Initializes the condition with the given SWTBot instance.
boolean	test() Tests if the condition has been met.

Method Detail

test

boolean test()
             throws Exception

Tests if the condition has been met.

Returns:

true if the condition is satisfied, false otherwise.

Throws:

Exception - if the test encounters an error while processing the check.

init

void init(SWTBot bot)

Initializes the condition with the given SWTBot instance. This should never be null.

Parameters:

bot - the SWTBot instance that this instance may use to evaluate the test.

getFailureMessage

String getFailureMessage()

Gets the failure message when a test fails (returns false).

Returns:

the failure message to show in case the test fails.