source: other-projects/trunk/gs3-release-maker/apache-ant-1.6.5/build/javadocs/org/apache/tools/ant/taskdefs/optional/junit/FormatterElement.html@ 14627

Last change on this file since 14627 was 14627, checked in by oranfry, 17 years ago

initial import of the gs3-release-maker
File size: 22.8 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!--NewPage-->
3<HTML>
4<HEAD>
5<!-- Generated by javadoc (build 1.4.2_13) on Mon Oct 01 14:33:28 NZST 2007 -->
6<TITLE>
7FormatterElement (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.taskdefs.optional.junit.FormatterElement class">
11
12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../../stylesheet.css" TITLE="Style">
13
14<SCRIPT type="text/javascript">
15function windowTitle()
16{
17 parent.document.title="FormatterElement (Apache Ant API)";
18}
19</SCRIPT>
20
21</HEAD>
22
23<BODY BGCOLOR="white" onload="windowTitle();">
24
25
26<!-- ========= START OF TOP NAVBAR ======= -->
27<A NAME="navbar_top"><!-- --></A>
28<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
29<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
30<TR>
31<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
32<A NAME="navbar_top_firstrow"><!-- --></A>
33<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
34 <TR ALIGN="center" VALIGN="top">
35 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
36 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
37 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
39 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
42 </TR>
43</TABLE>
44</TD>
45<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
46</EM>
47</TD>
48</TR>
49
50<TR>
51<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
52&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/junit/Enumerations.html" title="class in org.apache.tools.ant.taskdefs.optional.junit"><B>PREV CLASS</B></A>&nbsp;
53&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/junit/FormatterElement.TypeAttribute.html" title="class in org.apache.tools.ant.taskdefs.optional.junit"><B>NEXT CLASS</B></A></FONT></TD>
54<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
55 <A HREF="../../../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
56&nbsp;<A HREF="FormatterElement.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
57&nbsp;<SCRIPT type="text/javascript">
58 <!--
59 if(window==top) {
60 document.writeln('<A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
61 }
62 //-->
63</SCRIPT>
64<NOSCRIPT>
65 <A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
66</NOSCRIPT>
67
68</FONT></TD>
69</TR>
70<TR>
71<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
72 SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
73<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
74DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
75</TR>
76</TABLE>
77<A NAME="skip-navbar_top"></A>
78<!-- ========= END OF TOP NAVBAR ========= -->
79
80<HR>
81<!-- ======== START OF CLASS DATA ======== -->
82<H2>
83<FONT SIZE="-1">
84org.apache.tools.ant.taskdefs.optional.junit</FONT>
85<BR>
86Class FormatterElement</H2>
87<PRE>
88java.lang.Object
89 <IMG SRC="../../../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.taskdefs.optional.junit.FormatterElement</B>
90</PRE>
91<HR>
92<DL>
93<DT>public class <B>FormatterElement</B><DT>extends java.lang.Object</DL>
94
95<P>
96<p> A wrapper for the implementations of <code>JUnitResultFormatter</code>.
97 In particular, used as a nested <code>&lt;formatter&gt;</code> element in
98 a <code>&lt;junit&gt;</code> task.
99 <p> For example,
100 <code><pre>
101 &lt;junit printsummary="no" haltonfailure="yes" fork="false"&gt;
102 &lt;formatter type="plain" usefile="false" /&gt;
103 &lt;test name="org.apache.ecs.InternationalCharTest" /&gt;
104 &lt;/junit&gt;</pre></code>
105 adds a <code>plain</code> type implementation
106 (<code>PlainJUnitResultFormatter</code>) to display the results of the test.
107
108 <p> Either the <code>type</code> or the <code>classname</code> attribute
109 must be set.
110<P>
111
112<P>
113<DL>
114<DT><B>See Also:</B><DD><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/junit/JUnitTask.html" title="class in org.apache.tools.ant.taskdefs.optional.junit"><CODE>JUnitTask</CODE></A>,
115<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/junit/XMLJUnitResultFormatter.html" title="class in org.apache.tools.ant.taskdefs.optional.junit"><CODE>XMLJUnitResultFormatter</CODE></A>,
116<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/junit/BriefJUnitResultFormatter.html" title="class in org.apache.tools.ant.taskdefs.optional.junit"><CODE>BriefJUnitResultFormatter</CODE></A>,
117<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/junit/PlainJUnitResultFormatter.html" title="class in org.apache.tools.ant.taskdefs.optional.junit"><CODE>PlainJUnitResultFormatter</CODE></A>,
118<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/junit/JUnitResultFormatter.html" title="interface in org.apache.tools.ant.taskdefs.optional.junit"><CODE>JUnitResultFormatter</CODE></A></DL>
119<HR>
120
121<P>
122<!-- ======== NESTED CLASS SUMMARY ======== -->
123
124<A NAME="nested_class_summary"><!-- --></A>
125<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
126<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
127<TD COLSPAN=2><FONT SIZE="+2">
128<B>Nested Class Summary</B></FONT></TD>
129</TR>
130<TR BGCOLOR="white" CLASS="TableRowColor">
131<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
132<CODE>static&nbsp;class</CODE></FONT></TD>
133<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/junit/FormatterElement.TypeAttribute.html" title="class in org.apache.tools.ant.taskdefs.optional.junit">FormatterElement.TypeAttribute</A></B></CODE>
134
135<BR>
136&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Enumerated attribute with the values "plain", "xml" and "brief".</TD>
137</TR>
138</TABLE>
139&nbsp;
140<!-- =========== FIELD SUMMARY =========== -->
141
142<A NAME="field_summary"><!-- --></A>
143<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
144<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
145<TD COLSPAN=2><FONT SIZE="+2">
146<B>Field Summary</B></FONT></TD>
147</TR>
148<TR BGCOLOR="white" CLASS="TableRowColor">
149<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
150<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
151<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/junit/FormatterElement.html#BRIEF_FORMATTER_CLASS_NAME">BRIEF_FORMATTER_CLASS_NAME</A></B></CODE>
152
153<BR>
154&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
155</TR>
156<TR BGCOLOR="white" CLASS="TableRowColor">
157<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
158<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
159<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/junit/FormatterElement.html#PLAIN_FORMATTER_CLASS_NAME">PLAIN_FORMATTER_CLASS_NAME</A></B></CODE>
160
161<BR>
162&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
163</TR>
164<TR BGCOLOR="white" CLASS="TableRowColor">
165<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
166<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
167<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/junit/FormatterElement.html#XML_FORMATTER_CLASS_NAME">XML_FORMATTER_CLASS_NAME</A></B></CODE>
168
169<BR>
170&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
171</TR>
172</TABLE>
173&nbsp;
174<!-- ======== CONSTRUCTOR SUMMARY ======== -->
175
176<A NAME="constructor_summary"><!-- --></A>
177<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
178<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
179<TD COLSPAN=2><FONT SIZE="+2">
180<B>Constructor Summary</B></FONT></TD>
181</TR>
182<TR BGCOLOR="white" CLASS="TableRowColor">
183<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/junit/FormatterElement.html#FormatterElement()">FormatterElement</A></B>()</CODE>
184
185<BR>
186&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
187</TR>
188</TABLE>
189&nbsp;
190<!-- ========== METHOD SUMMARY =========== -->
191
192<A NAME="method_summary"><!-- --></A>
193<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
194<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
195<TD COLSPAN=2><FONT SIZE="+2">
196<B>Method Summary</B></FONT></TD>
197</TR>
198<TR BGCOLOR="white" CLASS="TableRowColor">
199<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
200<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
201<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/junit/FormatterElement.html#getClassname()">getClassname</A></B>()</CODE>
202
203<BR>
204&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get name of class to be used as the formatter.</TD>
205</TR>
206<TR BGCOLOR="white" CLASS="TableRowColor">
207<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
208<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
209<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/junit/FormatterElement.html#getExtension()">getExtension</A></B>()</CODE>
210
211<BR>
212&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
213</TR>
214<TR BGCOLOR="white" CLASS="TableRowColor">
215<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
216<CODE>&nbsp;void</CODE></FONT></TD>
217<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/junit/FormatterElement.html#setClassname(java.lang.String)">setClassname</A></B>(java.lang.String&nbsp;classname)</CODE>
218
219<BR>
220&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Set name of class to be used as the formatter.</TD>
221</TR>
222<TR BGCOLOR="white" CLASS="TableRowColor">
223<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
224<CODE>&nbsp;void</CODE></FONT></TD>
225<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/junit/FormatterElement.html#setExtension(java.lang.String)">setExtension</A></B>(java.lang.String&nbsp;ext)</CODE>
226
227<BR>
228&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
229</TR>
230<TR BGCOLOR="white" CLASS="TableRowColor">
231<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
232<CODE>&nbsp;void</CODE></FONT></TD>
233<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/junit/FormatterElement.html#setIf(java.lang.String)">setIf</A></B>(java.lang.String&nbsp;ifProperty)</CODE>
234
235<BR>
236&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set whether this formatter should be used.</TD>
237</TR>
238<TR BGCOLOR="white" CLASS="TableRowColor">
239<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
240<CODE>&nbsp;void</CODE></FONT></TD>
241<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/junit/FormatterElement.html#setOutput(java.io.OutputStream)">setOutput</A></B>(java.io.OutputStream&nbsp;out)</CODE>
242
243<BR>
244&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Set output stream for formatter to use.</TD>
245</TR>
246<TR BGCOLOR="white" CLASS="TableRowColor">
247<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
248<CODE>&nbsp;void</CODE></FONT></TD>
249<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/junit/FormatterElement.html#setType(org.apache.tools.ant.taskdefs.optional.junit.FormatterElement.TypeAttribute)">setType</A></B>(<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/junit/FormatterElement.TypeAttribute.html" title="class in org.apache.tools.ant.taskdefs.optional.junit">FormatterElement.TypeAttribute</A>&nbsp;type)</CODE>
250
251<BR>
252&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Quick way to use a standard formatter.</TD>
253</TR>
254<TR BGCOLOR="white" CLASS="TableRowColor">
255<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
256<CODE>&nbsp;void</CODE></FONT></TD>
257<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/junit/FormatterElement.html#setUnless(java.lang.String)">setUnless</A></B>(java.lang.String&nbsp;unlessProperty)</CODE>
258
259<BR>
260&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set whether this formatter should NOT be used.</TD>
261</TR>
262<TR BGCOLOR="white" CLASS="TableRowColor">
263<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
264<CODE>&nbsp;void</CODE></FONT></TD>
265<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/junit/FormatterElement.html#setUseFile(boolean)">setUseFile</A></B>(boolean&nbsp;useFile)</CODE>
266
267<BR>
268&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set whether the formatter should log to file.</TD>
269</TR>
270<TR BGCOLOR="white" CLASS="TableRowColor">
271<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
272<CODE>&nbsp;boolean</CODE></FONT></TD>
273<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/junit/FormatterElement.html#shouldUse(org.apache.tools.ant.Task)">shouldUse</A></B>(<A HREF="../../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A>&nbsp;t)</CODE>
274
275<BR>
276&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Ensures that the selector passes the conditions placed
277 on it with <code>if</code> and <code>unless</code> properties.</TD>
278</TR>
279</TABLE>
280&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
281<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
282<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
283<TD><B>Methods inherited from class java.lang.Object</B></TD>
284</TR>
285<TR BGCOLOR="white" CLASS="TableRowColor">
286<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
287</TR>
288</TABLE>
289&nbsp;
290<P>
291
292<!-- ============ FIELD DETAIL =========== -->
293
294<A NAME="field_detail"><!-- --></A>
295<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
296<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
297<TD COLSPAN=1><FONT SIZE="+2">
298<B>Field Detail</B></FONT></TD>
299</TR>
300</TABLE>
301
302<A NAME="XML_FORMATTER_CLASS_NAME"><!-- --></A><H3>
303XML_FORMATTER_CLASS_NAME</H3>
304<PRE>
305public static final java.lang.String <B>XML_FORMATTER_CLASS_NAME</B></PRE>
306<DL>
307<DL>
308<DT><B>See Also:</B><DD><A HREF="../../../../../../../constant-values.html#org.apache.tools.ant.taskdefs.optional.junit.FormatterElement.XML_FORMATTER_CLASS_NAME">Constant Field Values</A></DL>
309</DL>
310<HR>
311
312<A NAME="BRIEF_FORMATTER_CLASS_NAME"><!-- --></A><H3>
313BRIEF_FORMATTER_CLASS_NAME</H3>
314<PRE>
315public static final java.lang.String <B>BRIEF_FORMATTER_CLASS_NAME</B></PRE>
316<DL>
317<DL>
318<DT><B>See Also:</B><DD><A HREF="../../../../../../../constant-values.html#org.apache.tools.ant.taskdefs.optional.junit.FormatterElement.BRIEF_FORMATTER_CLASS_NAME">Constant Field Values</A></DL>
319</DL>
320<HR>
321
322<A NAME="PLAIN_FORMATTER_CLASS_NAME"><!-- --></A><H3>
323PLAIN_FORMATTER_CLASS_NAME</H3>
324<PRE>
325public static final java.lang.String <B>PLAIN_FORMATTER_CLASS_NAME</B></PRE>
326<DL>
327<DL>
328<DT><B>See Also:</B><DD><A HREF="../../../../../../../constant-values.html#org.apache.tools.ant.taskdefs.optional.junit.FormatterElement.PLAIN_FORMATTER_CLASS_NAME">Constant Field Values</A></DL>
329</DL>
330
331<!-- ========= CONSTRUCTOR DETAIL ======== -->
332
333<A NAME="constructor_detail"><!-- --></A>
334<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
335<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
336<TD COLSPAN=1><FONT SIZE="+2">
337<B>Constructor Detail</B></FONT></TD>
338</TR>
339</TABLE>
340
341<A NAME="FormatterElement()"><!-- --></A><H3>
342FormatterElement</H3>
343<PRE>
344public <B>FormatterElement</B>()</PRE>
345<DL>
346</DL>
347
348<!-- ============ METHOD DETAIL ========== -->
349
350<A NAME="method_detail"><!-- --></A>
351<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
352<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
353<TD COLSPAN=1><FONT SIZE="+2">
354<B>Method Detail</B></FONT></TD>
355</TR>
356</TABLE>
357
358<A NAME="setType(org.apache.tools.ant.taskdefs.optional.junit.FormatterElement.TypeAttribute)"><!-- --></A><H3>
359setType</H3>
360<PRE>
361public void <B>setType</B>(<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/junit/FormatterElement.TypeAttribute.html" title="class in org.apache.tools.ant.taskdefs.optional.junit">FormatterElement.TypeAttribute</A>&nbsp;type)</PRE>
362<DL>
363<DD><p> Quick way to use a standard formatter.
364
365 <p> At the moment, there are three supported standard formatters.
366 <ul>
367 <li> The <code>xml</code> type uses a <code>XMLJUnitResultFormatter</code>.
368 <li> The <code>brief</code> type uses a <code>BriefJUnitResultFormatter</code>.
369 <li> The <code>plain</code> type (the default) uses a <code>PlainJUnitResultFormatter</code>.
370 </ul>
371
372 <p> Sets <code>classname</code> attribute - so you can't use that
373 attribute if you use this one.
374<P>
375<DD><DL>
376</DL>
377</DD>
378</DL>
379<HR>
380
381<A NAME="setClassname(java.lang.String)"><!-- --></A><H3>
382setClassname</H3>
383<PRE>
384public void <B>setClassname</B>(java.lang.String&nbsp;classname)</PRE>
385<DL>
386<DD><p> Set name of class to be used as the formatter.
387
388 <p> This class must implement <code>JUnitResultFormatter</code>
389<P>
390<DD><DL>
391</DL>
392</DD>
393</DL>
394<HR>
395
396<A NAME="getClassname()"><!-- --></A><H3>
397getClassname</H3>
398<PRE>
399public java.lang.String <B>getClassname</B>()</PRE>
400<DL>
401<DD>Get name of class to be used as the formatter.
402<P>
403<DD><DL>
404</DL>
405</DD>
406</DL>
407<HR>
408
409<A NAME="setExtension(java.lang.String)"><!-- --></A><H3>
410setExtension</H3>
411<PRE>
412public void <B>setExtension</B>(java.lang.String&nbsp;ext)</PRE>
413<DL>
414<DD><DL>
415</DL>
416</DD>
417</DL>
418<HR>
419
420<A NAME="getExtension()"><!-- --></A><H3>
421getExtension</H3>
422<PRE>
423public java.lang.String <B>getExtension</B>()</PRE>
424<DL>
425<DD><DL>
426</DL>
427</DD>
428</DL>
429<HR>
430
431<A NAME="setOutput(java.io.OutputStream)"><!-- --></A><H3>
432setOutput</H3>
433<PRE>
434public void <B>setOutput</B>(java.io.OutputStream&nbsp;out)</PRE>
435<DL>
436<DD><p> Set output stream for formatter to use.
437
438 <p> Defaults to standard out.
439<P>
440<DD><DL>
441</DL>
442</DD>
443</DL>
444<HR>
445
446<A NAME="setUseFile(boolean)"><!-- --></A><H3>
447setUseFile</H3>
448<PRE>
449public void <B>setUseFile</B>(boolean&nbsp;useFile)</PRE>
450<DL>
451<DD>Set whether the formatter should log to file.
452<P>
453<DD><DL>
454</DL>
455</DD>
456</DL>
457<HR>
458
459<A NAME="setIf(java.lang.String)"><!-- --></A><H3>
460setIf</H3>
461<PRE>
462public void <B>setIf</B>(java.lang.String&nbsp;ifProperty)</PRE>
463<DL>
464<DD>Set whether this formatter should be used. It will be
465 used if the property has been set, otherwise it won't.
466<P>
467<DD><DL>
468<DT><B>Parameters:</B><DD><CODE>ifProperty</CODE> - name of property</DL>
469</DD>
470</DL>
471<HR>
472
473<A NAME="setUnless(java.lang.String)"><!-- --></A><H3>
474setUnless</H3>
475<PRE>
476public void <B>setUnless</B>(java.lang.String&nbsp;unlessProperty)</PRE>
477<DL>
478<DD>Set whether this formatter should NOT be used. It
479 will not be used if the property has been set, orthwise it
480 will be used.
481<P>
482<DD><DL>
483<DT><B>Parameters:</B><DD><CODE>unlessProperty</CODE> - name of property</DL>
484</DD>
485</DL>
486<HR>
487
488<A NAME="shouldUse(org.apache.tools.ant.Task)"><!-- --></A><H3>
489shouldUse</H3>
490<PRE>
491public boolean <B>shouldUse</B>(<A HREF="../../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A>&nbsp;t)</PRE>
492<DL>
493<DD>Ensures that the selector passes the conditions placed
494 on it with <code>if</code> and <code>unless</code> properties.
495<P>
496<DD><DL>
497</DL>
498</DD>
499</DL>
500<!-- ========= END OF CLASS DATA ========= -->
501<HR>
502
503
504<!-- ======= START OF BOTTOM NAVBAR ====== -->
505<A NAME="navbar_bottom"><!-- --></A>
506<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
507<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
508<TR>
509<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
510<A NAME="navbar_bottom_firstrow"><!-- --></A>
511<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
512 <TR ALIGN="center" VALIGN="top">
513 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
514 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
515 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
516 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
517 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
518 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
519 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
520 </TR>
521</TABLE>
522</TD>
523<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
524</EM>
525</TD>
526</TR>
527
528<TR>
529<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
530&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/junit/Enumerations.html" title="class in org.apache.tools.ant.taskdefs.optional.junit"><B>PREV CLASS</B></A>&nbsp;
531&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/junit/FormatterElement.TypeAttribute.html" title="class in org.apache.tools.ant.taskdefs.optional.junit"><B>NEXT CLASS</B></A></FONT></TD>
532<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
533 <A HREF="../../../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
534&nbsp;<A HREF="FormatterElement.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
535&nbsp;<SCRIPT type="text/javascript">
536 <!--
537 if(window==top) {
538 document.writeln('<A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
539 }
540 //-->
541</SCRIPT>
542<NOSCRIPT>
543 <A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
544</NOSCRIPT>
545
546</FONT></TD>
547</TR>
548<TR>
549<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
550 SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
551<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
552DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
553</TR>
554</TABLE>
555<A NAME="skip-navbar_bottom"></A>
556<!-- ======== END OF BOTTOM NAVBAR ======= -->
557
558<HR>
559Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
560</BODY>
561</HTML>
Note: See TracBrowser for help on using the repository browser.