Package de.hsh.graja.core
Class ModuleRunnerResult
- java.lang.Object
-
- de.hsh.graja.core.ModuleRunnerResult
-
- All Implemented Interfaces:
ContentLogger
,Serializable
- Direct Known Subclasses:
CheckstyleModuleRunnerResult
,CompileModuleRunnerResult
,HumanModuleRunnerResult
,JunitModuleRunnerResult
,PmdModuleRunnerResult
public abstract class ModuleRunnerResult extends Object implements ContentLogger, Serializable
A module runner result is the abstract base class of any module runner result. As an abstract class it provides functions and data for comments (leading and trailing comments). A module runner can append comments to each of the two comment collections. Trailing comments usually are added for a summary report. Leading comments can be used by a module runner for logging the process of module runner execution.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description ModuleRunnerResult()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description void
addItem(Content item)
This method implementsCommentLogger
and simply delegates to#addLeadingCommentItem(Comment)
.void
addLeadingCommentItem(Content item)
Add a comment to the collection of leading comments.void
addTrailingCommentItem(Content item)
Add a comment to the collection of trailing comments.Sequence
getLeadingComment()
Sequence
getTrailingComment()
abstract ModuleType
getType()
boolean
isTimeout()
void
prependLeadingCommentItems(Collection<? extends Content> items)
Replace the leading comments by a new sequence withitems
prepended.void
setTimeout()
-
-
-
Method Detail
-
addItem
public void addItem(Content item)
This method implementsCommentLogger
and simply delegates to#addLeadingCommentItem(Comment)
.- Specified by:
addItem
in interfaceContentLogger
- Parameters:
item
- a comment to be added to leading comments
-
addLeadingCommentItem
public void addLeadingCommentItem(Content item)
Add a comment to the collection of leading comments.- Parameters:
item
- a comment to be added to leading comments.
-
prependLeadingCommentItems
public void prependLeadingCommentItems(Collection<? extends Content> items)
Replace the leading comments by a new sequence withitems
prepended.- Parameters:
items
-
-
addTrailingCommentItem
public void addTrailingCommentItem(Content item)
Add a comment to the collection of trailing comments.- Parameters:
item
- a comment to be added to trailing comments.
-
getLeadingComment
public Sequence getLeadingComment()
- Returns:
- the collection of leading comments
-
getTrailingComment
public Sequence getTrailingComment()
- Returns:
- the collection of trailing comments
-
isTimeout
public boolean isTimeout()
- Returns:
- true, if the test run exceeded the maximum runtime
-
setTimeout
public void setTimeout()
-
getType
public abstract ModuleType getType()
-
-