package Torello.Java.Build;

import Torello.Java.StorageWriter;

import java.io.IOException;

/**
 * Used to identify any and all top-level testing classes which should be invoked in order to run 
 * the tests located in a {@code '../test-classes/'} directory.
 * 
 * <EMBED CLASS='external-html' DATA-FILE-ID=JSON_TEST_DIR>
 * @see Testing
 */
public interface TestingClass
{
    /**
     * This method must be implemented in order for the Test-Suite Class-Builder to be able to 
     * identify which method should be invoked in order to run the tests
     * 
     * @param sw This is used as a logging parameter.
     * @return {@code TRUE} if all tests succeeded, and {@code FALSE} if a single test failed.
     * 
     * @throws IOException This is allowed to throw.  The {@link StorageWriter} class permits this
     * excetion throw with many of its methods.
     */
    public boolean runTests(StorageWriter sw) throws IOException;
}