|
|||||||||||||||||||
Source file | Conditionals | Statements | Methods | TOTAL | |||||||||||||||
IRunnerClean.java | - | - | - | - |
|
1 | /** | |
2 | * JTRunner is free software; you can redistribute it and/or modify it under the | |
3 | * terms of the GNU General Public License as published by the Free Software | |
4 | * Foundation; either version 2, or (at your option) any later version. | |
5 | */ | |
6 | ||
7 | package jtr.runners; | |
8 | ||
9 | import jtr.config.*; | |
10 | import jtr.config.enterprise.EnterpriseConfig; | |
11 | import jtr.assigner.*; | |
12 | import jtr.test.ITestCompletionListener; | |
13 | import jtr.test.TestOutcomeTable; | |
14 | import jtr.test.IOutcomeFactory; | |
15 | ||
16 | /** | |
17 | * This interface represents a runner in its <code>CLEAN</code> state. <br> | |
18 | * This means that the runner has simply been created but not parameterized yet.<br> | |
19 | * The next admitted state can only be <code>PARAMETERIZED</code>. | |
20 | * | |
21 | * @author Francesco Russo (frusso@dev.java.net) | |
22 | * @version 4.0 | |
23 | * @since 1.0 | |
24 | */ | |
25 | public interface IRunnerClean { | |
26 | /** | |
27 | * Set the logical name of the current runner. | |
28 | * | |
29 | * @param name | |
30 | * String | |
31 | */ | |
32 | public void setName(String name); | |
33 | ||
34 | /** | |
35 | * Get the logical name of the current runner. | |
36 | * | |
37 | * @return String | |
38 | */ | |
39 | public String getName(); | |
40 | ||
41 | /** | |
42 | * Get the JTR-assigned unique name of the current runner. | |
43 | * | |
44 | * @return String | |
45 | */ | |
46 | public String getDefaultName(); | |
47 | ||
48 | /** | |
49 | * Get the enterprise configuration associated with the current runner. | |
50 | * | |
51 | * @return EnterpriseConfig | |
52 | */ | |
53 | public EnterpriseConfig getEnterprise(); | |
54 | ||
55 | /** | |
56 | * Set the enterprise configuration associated with the current runner. | |
57 | * | |
58 | * @param enterprise | |
59 | * EnterpriseConfig | |
60 | */ | |
61 | public void setEnterprise(EnterpriseConfig enterprise); | |
62 | ||
63 | /** | |
64 | * Get the total number of runs this runner has to execute. | |
65 | * | |
66 | * @return int | |
67 | */ | |
68 | public int getRuns(); | |
69 | ||
70 | /** | |
71 | * Set the total number of runs this runner has to execute. | |
72 | * | |
73 | * @param runs | |
74 | * int | |
75 | */ | |
76 | public void setRuns(int runs); | |
77 | ||
78 | /** | |
79 | * Get the sleep time value assigned to the current runner. | |
80 | * | |
81 | * @return long | |
82 | */ | |
83 | public long getSleepTime(); | |
84 | ||
85 | /** | |
86 | * Set the sleep time value assigned to the current runner. | |
87 | * | |
88 | * @param sleepTime | |
89 | * long | |
90 | */ | |
91 | public void setSleepTime(long sleepTime); | |
92 | ||
93 | /** | |
94 | * Set the paramters for the current runner. | |
95 | * | |
96 | * @param params | |
97 | */ | |
98 | public void setParameters(ParametersMap params); | |
99 | ||
100 | /** | |
101 | * Get the paramters for the current runner. | |
102 | * | |
103 | * @return ParametersMap | |
104 | */ | |
105 | public ParametersMap getParameters(); | |
106 | ||
107 | /** | |
108 | * Get the assigner in charge of performing the parameters injection into | |
109 | * the current runner. | |
110 | * | |
111 | * @return IParamsAssigner | |
112 | */ | |
113 | public IParamsAssigner getParamsAssigner(); | |
114 | ||
115 | /** | |
116 | * Set the assigner in charge of performing the parameters injection into | |
117 | * the current runner. | |
118 | * | |
119 | * @param paramsAssigner | |
120 | * IParamsAssigner | |
121 | */ | |
122 | public void setParamsAssigner(IParamsAssigner paramsAssigner); | |
123 | ||
124 | /** | |
125 | * Get the <code>TestOutcomeTable</code> instance where the runner logs | |
126 | * all the experienced error conditions. | |
127 | * | |
128 | * @return TestOutcomeTable | |
129 | */ | |
130 | public TestOutcomeTable getTestOutcomeTable(); | |
131 | ||
132 | /** | |
133 | * Set the <code>TestOutcomeTable</code> instance where the runner logs | |
134 | * all the experienced error conditions. | |
135 | * | |
136 | * @param testOutcomeTable | |
137 | * TestOutcomeTable | |
138 | */ | |
139 | public void setTestOutcomeTable(TestOutcomeTable testOutcomeTable); | |
140 | ||
141 | /** | |
142 | * Get the factory in charge of instantiating <code>IOutCome</code> | |
143 | * instances. | |
144 | * | |
145 | * @return IOutcomeFactory | |
146 | */ | |
147 | public IOutcomeFactory getOutcomeFactory(); | |
148 | ||
149 | /** | |
150 | * Set the factory in charge of instantiating <code>IOutCome</code> | |
151 | * instances. | |
152 | * | |
153 | * @param outcomeFactory | |
154 | * IOutcomeFactory | |
155 | */ | |
156 | public void setOutcomeFactory(IOutcomeFactory outcomeFactory); | |
157 | ||
158 | /** | |
159 | * Set the number of instances that must be active, according to the | |
160 | * jtr.xml, during the test-suite. | |
161 | * | |
162 | * @param i The number of instances | |
163 | */ | |
164 | public void setInstanceCount(int i); | |
165 | ||
166 | /** | |
167 | * Get the number of instances that must be active, according to the | |
168 | * jtr.xml, during the test-suite. | |
169 | * | |
170 | * @return The number of instances | |
171 | */ | |
172 | public int getInstanceCount(); | |
173 | ||
174 | /** | |
175 | * This method assigns an <code>ITestCompletionListener</code> instance | |
176 | * to a runner in <code>CLEAN</code> state. This assignment can be performed | |
177 | * for just one time in a JTR test-session for each runner instance.<br> | |
178 | * <b>Note:</b> it is legal for this instance to be always <code>null</code> | |
179 | * for runner instances started on JTR passive-nodes. | |
180 | * | |
181 | * @param testComplLsnr The listener instance | |
182 | */ | |
183 | public void setTestCompletionListener(ITestCompletionListener testComplLsnr); | |
184 | } |
|