Class FormatterElement
java.lang.Object
org.apache.tools.ant.taskdefs.optional.junit.FormatterElement
A wrapper for the implementations of JUnitResultFormatter
.
In particular, used as a nested <formatter>
element in
a <junit>
task.
<junit printsummary="no" haltonfailure="yes" fork="false"> <formatter type="plain" usefile="false" /> <test name="org.apache.ecs.InternationalCharTest" /> </junit>adds a
plain
type implementation
(PlainJUnitResultFormatter
) to display the results of the test.
Either the type
or the classname
attribute
must be set.
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
Enumerated attribute with the values "plain", "xml", "brief" and "failure". -
Field Summary
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGet name of class to be used as the formatter.Get the extension used for the report file.void
setClassname
(String classname) Set name of class to be used as the formatter.void
setExtension
(String ext) Set the extension to use for the report file.void
Set whether this formatter should be used.void
Set whether this formatter should be used.void
setOutput
(OutputStream out) Set output stream for formatter to use.void
setProject
(Project project) Store the project reference for passing it to nested components.void
Quick way to use a standard formatter.void
Set whether this formatter should NOT be used.void
Set whether this formatter should NOT be used.void
setUseFile
(boolean useFile) Set whether the formatter should log to file.boolean
Ensures that the selector passes the conditions placed on it withif
andunless
properties.
-
Field Details
-
XML_FORMATTER_CLASS_NAME
-
BRIEF_FORMATTER_CLASS_NAME
-
PLAIN_FORMATTER_CLASS_NAME
-
FAILURE_RECORDER_CLASS_NAME
-
-
Constructor Details
-
FormatterElement
public FormatterElement()
-
-
Method Details
-
setType
Quick way to use a standard formatter.
At the moment, there are three supported standard formatters.
- The
xml
type uses aXMLJUnitResultFormatter
. - The
brief
type uses aBriefJUnitResultFormatter
. - The
plain
type (the default) uses aPlainJUnitResultFormatter
. - The
failure
type uses aFailureRecorder
.
Sets
classname
attribute - so you can't use that attribute if you use this one.- Parameters:
type
- the enumerated value to use.
- The
-
setClassname
Set name of class to be used as the formatter.This class must implement
JUnitResultFormatter
- Parameters:
classname
- the name of the formatter class.
-
getClassname
Get name of class to be used as the formatter.- Returns:
- the name of the class.
-
setExtension
Set the extension to use for the report file.- Parameters:
ext
- the extension to use.
-
getExtension
-
setOutput
Set output stream for formatter to use.Defaults to standard out.
- Parameters:
out
- the output stream to use.
-
setUseFile
public void setUseFile(boolean useFile) Set whether the formatter should log to file.- Parameters:
useFile
- if true use a file, if false send to standard out.
-
setIf
Set whether this formatter should be used. It will be used if the expression evaluates to true or the name of a property which has been set, otherwise it won't.- Parameters:
ifCond
- name of property- Since:
- Ant 1.8.0
-
setIf
Set whether this formatter should be used. It will be used if the expression evaluates to true or the name of a property which has been set, otherwise it won't.- Parameters:
ifCond
- name of property
-
setUnless
Set whether this formatter should NOT be used. It will be used if the expression evaluates to false or the name of a property which has not been set, otherwise it will not be used.- Parameters:
unlessCond
- name of property- Since:
- Ant 1.8.0
-
setUnless
Set whether this formatter should NOT be used. It will be used if the expression evaluates to false or the name of a property which has not been set, otherwise it will not be used.- Parameters:
unlessCond
- name of property
-
shouldUse
Ensures that the selector passes the conditions placed on it withif
andunless
properties.- Parameters:
t
- the task the this formatter is used in.- Returns:
- true if the formatter should be used.
-
setProject
Store the project reference for passing it to nested components.- Parameters:
project
- the reference- Since:
- Ant 1.8
-