hudson.plugins.rubyMetrics.railsNotes.model
Class RailsNotesResults

java.lang.Object
  hudson.plugins.rubyMetrics.railsNotes.model.RailsNotesResults

public class RailsNotesResults
extends java.lang.Object

Constructor Summary

RailsNotesResults()

Method Summary

void	addAnnotationFor(java.lang.String fileName, RailsNotesMetrics annotation) Add an instance of annotation in the file fileName.
java.util.Collection<java.lang.String>	getHeaders()
java.util.Map<java.lang.String,java.util.Map<RailsNotesMetrics,java.lang.Integer>>	getMetrics()
java.lang.String	getOutput()
java.util.Map<RailsNotesMetrics,java.lang.Integer>	getTotal() Generate the total count of each annotation by adding together all the annotations in metrics.
void	setOutput(java.lang.String output)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RailsNotesResults

public RailsNotesResults()

Method Detail

getHeaders

public java.util.Collection<java.lang.String> getHeaders()

addAnnotationFor

public void addAnnotationFor(java.lang.String fileName,
                             RailsNotesMetrics annotation)

Add an instance of annotation in the file fileName. This will create an entry in metrics for fileName if one does not already exist.

Parameters:

fileName - the filename from the output of Rails notes.

annotation - the RailsNotesMetrics value associated with the annotation in the report.

getTotal

public java.util.Map<RailsNotesMetrics,java.lang.Integer> getTotal()

Generate the total count of each annotation by adding together all the annotations in metrics.

Returns:

A Map to insert into metrics with each annotation and a total count.

getMetrics

public java.util.Map<java.lang.String,java.util.Map<RailsNotesMetrics,java.lang.Integer>> getMetrics()

getOutput

public java.lang.String getOutput()

Returns:

the output of the "rake notes" command.

setOutput

public void setOutput(java.lang.String output)

Parameters:

output - the output of the "rake notes" command.