1/*
2 [The "BSD license"]
3 Copyright (c) 2009 Shaoting Cai
4 All rights reserved.
5
6 Redistribution and use in source and binary forms, with or without
7 modification, are permitted provided that the following conditions
8 are met:
9 1. Redistributions of source code must retain the above copyright
10    notice, this list of conditions and the following disclaimer.
11 2. Redistributions in binary form must reproduce the above copyright
12    notice, this list of conditions and the following disclaimer in the
13    documentation and/or other materials provided with the distribution.
14 3. The name of the author may not be used to endorse or promote products
15    derived from this software without specific prior written permission.
16
17 THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27*/
28package org.antlr.gunit;
29
30/**
31 * ITestCase object locates one test case in a gUnit script by specifying the
32 * tested rule and the index number of the test case in that group.
33 *
34 * For example:
35 * ----------------------
36 * ...
37 * varDef:
38 * "int i;" OK
39 * "float 2f;" FAIL
40 * ...
41 * ----------------------
42 * The "testedRuleName" for these two test cases will be "varDef".
43 * The "index" for the "int"-test will be 0.
44 * The "index" for the "float"-test will be 1.  And so on.
45 *
46 * @see ITestSuite
47 */
48public interface ITestCase {
49
50    /**
51     * Get the name of the rule that is tested by this test case.
52     * @return name of the tested rule.
53     */
54    public String getTestedRuleName();
55
56    /**
57     * Get the index of the test case in the test group for a rule. Starting
58     * from 0.
59     * @return index number of the test case.
60     */
61    public int getTestCaseIndex();
62
63}
64