Package analyzer

Interface OutputCollector

public interface OutputCollector

This interface is used to collect analyzer output in the form of comments, tags and an optional summary.

See Also:

• The analyzer interface in the Exercism documentation

Method Summary

Modifier and Type	Method	Description
void	addComment(Comment comment)	Add a new comment to the analysis.
void	addTag(String tag)	Add a new tag to the analysis.
List<Comment>	getComments()	Retrieve a copy of the comments added to this analysis.
String	getSummary()	The summary is a short description of the complete analysis result.
List<String>	getTags()	Retrieve a copy of the tags added to this analysis.
void	setSummary(String summary)	Set the summary of the analysis.

Method Details

getSummary

String getSummary()

The summary is a short description of the complete analysis result. It is null by default.

Returns:

The summary if set, null otherwise.

setSummary

void setSummary(String summary)

Set the summary of the analysis. If the summary was set previously, setting it again will overwrite it. The summary can be cleared by setting it to null.

Parameters:

summary - The summary to set.

getComments

List<Comment> getComments()

Retrieve a copy of the comments added to this analysis. The resulting list is guaranteed to contain no duplicates.

Returns:

List of comments.

getTags

List<String> getTags()

Retrieve a copy of the tags added to this analysis. The resulting list is guaranteed to contain no duplicates.

Returns:

List of tags.

addComment

void addComment(Comment comment)

Add a new comment to the analysis. This does nothing if a comment with the same values was added previously.

Parameters:

comment - The comment to add.

addTag

void addTag(String tag)

Add a new tag to the analysis. This does nothing if the same tag was added previously.

Parameters:

tag - The tag to add.