as2lib 0.9

     1  /**
     2   * Copyright the original author or authors.
     3   * 
     4   * Licensed under the MOZILLA PUBLIC LICENSE, Version 1.1 (the "License");
     5   * you may not use this file except in compliance with the License.
     6   * You may obtain a copy of the License at
     7   * 
     8   *      http://www.mozilla.org/MPL/MPL-1.1.html
     9   * 
    10   * Unless required by applicable law or agreed to in writing, software
    11   * distributed under the License is distributed on an "AS IS" BASIS,
    12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13   * See the License for the specific language governing permissions and
    14   * limitations under the License.
    15   */
    16  
    17  import org.as2lib.core.BasicInterface;
    18  import org.as2lib.test.unit.TestRunner;
    19  
    20  /**
    21   * {@code Test} is the definition for any test in a unit-testing context.
    22   * 
    23   * <p>To start a {@code Test} you simple have to execute {@code run}. It logs all
    24   * output by default to a {@code Logger}.
    25   *
    26   * @author Martin Heidegger
    27   * @version 2.0
    28   * @see TestRunner
    29   */
    30  interface org.as2lib.test.unit.Test extends BasicInterface {
    31  		
    32  	/**
    33  	 * Runs the test.
    34  	 * 
    35  	 * @return {@code TestRunner} that executes this test
    36  	 */
    37  	public function run(Void):TestRunner;
    38  	
    39  	/**
    40  	 * Returns the {@code TestRunner} that executes this {@code Test}.
    41  	 * 
    42  	 * <p>Every {@code Test} is ment to have a {@code TestRunner} that knows
    43  	 * how the informations of the {@code Test} have to be used to execute to
    44  	 * evaluate the result.
    45  	 * 
    46  	 * @return {@code TestRunner} that executes this test
    47  	 */
    48  	public function getTestRunner(Void):TestRunner;
    49  }