01: /*******************************************************************************
02: * Copyright (c) 2003, 2006 IBM Corporation and others.
03: * All rights reserved. This program and the accompanying materials
04: * are made available under the terms of the Eclipse Public License v1.0
05: * which accompanies this distribution, and is available at
06: * http://www.eclipse.org/legal/epl-v10.html
07: *
08: * Contributors:
09: * IBM Corporation - initial API and implementation
10: *******************************************************************************/package org.eclipse.ui.testing;
11:
12: import org.eclipse.core.runtime.Assert;
13:
14: /**
15: * A testable object.
16: * Allows a test harness to register itself with a testable object.
17: * The test harness is notified of test-related lifecycle events,
18: * such as when is an appropriate time to run tests on the object.
19: * This also provides API for running tests as a runnable, and for signaling
20: * when the tests are starting and when they are finished.
21: * <p>
22: * The workbench provides an implementation of this facade, available
23: * via <code>PlatformUI.getTestableObject()</code>.
24: * </p>
25: *
26: * @since 3.0
27: */
28: public class TestableObject {
29:
30: private ITestHarness testHarness;
31:
32: /**
33: * Returns the test harness, or <code>null</code> if it has not yet been set.
34: *
35: * @return the test harness or <code>null</code>
36: */
37: public ITestHarness getTestHarness() {
38: return testHarness;
39: }
40:
41: /**
42: * Sets the test harness.
43: *
44: * @param testHarness the test harness
45: */
46: public void setTestHarness(ITestHarness testHarness) {
47: Assert.isNotNull(testHarness);
48: this .testHarness = testHarness;
49: }
50:
51: /**
52: * Runs the given test runnable.
53: * The default implementation simply invokes <code>run</code> on the
54: * given test runnable. Subclasses may extend.
55: *
56: * @param testRunnable the test runnable to run
57: */
58: public void runTest(Runnable testRunnable) {
59: testRunnable.run();
60: }
61:
62: /**
63: * Notification from the test harness that it is starting to run
64: * the tests.
65: * The default implementation does nothing.
66: * Subclasses may override.
67: */
68: public void testingStarting() {
69: // do nothing
70: }
71:
72: /**
73: * Notification from the test harness that it has finished running the
74: * tests.
75: * The default implementation does nothing.
76: * Subclasses may override.
77: */
78: public void testingFinished() {
79: // do nothing
80: }
81: }
|