hudson.plugins.violations.model
Class FileSummary

java.lang.Object
  hudson.plugins.violations.model.FileSummary

All Implemented Interfaces:

java.lang.Comparable<FileSummary>

public class FileSummary
extends java.lang.Object
implements java.lang.Comparable<FileSummary>

A set of violations from a full file model for a particualar type.

Constructor Summary

FileSummary(FullFileModel fileModel, java.util.TreeSet violations)
Constructor for FileSummary.

Method Summary

int	compareTo(FileSummary other) Implemenate a compare to based on the number of violations.
FullFileModel	getFileModel() Get the file model.
java.util.TreeSet	getViolations() Get the associated violations.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileSummary

public FileSummary(FullFileModel fileModel,
                   java.util.TreeSet violations)

Constructor for FileSummary.

Parameters:

fileModel - the file model

violations - the violation set to associate with the file model.

Method Detail

getFileModel

public FullFileModel getFileModel()

Get the file model.

Returns:

the full file model.

getViolations

public java.util.TreeSet getViolations()

Get the associated violations.

Returns:

the violations.

compareTo

public int compareTo(FileSummary other)

Implemenate a compare to based on the number of violations.

Specified by:

compareTo in interface java.lang.Comparable<FileSummary>

Parameters:

other - the other summary to campare to.

Returns:

0 if same, 1 if less and -1 if greater (need most at top)