org.jboss.tattletale.reporting
Class Report

java.lang.Object
  org.jboss.tattletale.reporting.Report

All Implemented Interfaces:

java.lang.Comparable

Direct Known Subclasses:

ArchiveReport, BlackListedReport, ClassLocationReport, DependantsReport, DependsOnReport, EliminateJarsReport, GraphvizReport, InvalidVersionReport, MultipleJarsReport, MultipleLocationsReport, NoVersionReport, OSGiReport, TransitiveDependantsReport, TransitiveDependsOnReport

public abstract class Report
extends java.lang.Object
implements java.lang.Comparable

Represents a report

Author:

Jesper Pedersen

Field Summary

protected java.util.SortedSet<Archive>	archives The actions
protected int	severity The severity
protected int	status The status

Constructor Summary

Report(int severity, java.util.SortedSet<Archive> archives)
Constructor

Method Summary

int	compareTo(java.lang.Object o) Comparable
boolean	equals(java.lang.Object obj) Equals
abstract void	generate(java.lang.String outputDirectory) Generate the report(s)
abstract java.lang.String	getDirectory() Get the name of the directory
abstract java.lang.String	getName() Get the name of the report
int	getSeverity() Get the severity
int	getStatus() Get the status
int	hashCode() Hash code

Methods inherited from class java.lang.Object

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

Field Detail

severity

protected int severity

The severity

status

protected int status

The status

archives

protected java.util.SortedSet<Archive> archives

The actions

Constructor Detail

Report

public Report(int severity,
              java.util.SortedSet<Archive> archives)

Constructor

Parameters:

severity - The severity

archives - The archives

Method Detail

getSeverity

public int getSeverity()

Get the severity

Returns:

The value

getStatus

public int getStatus()

Get the status

Returns:

The value

getName

public abstract java.lang.String getName()

Get the name of the report

Returns:

The name

getDirectory

public abstract java.lang.String getDirectory()

Get the name of the directory

Returns:

The directory

generate

public abstract void generate(java.lang.String outputDirectory)

Generate the report(s)

Parameters:

outputDirectory - The top-level output directory

compareTo

public int compareTo(java.lang.Object o)

Comparable

Specified by:

compareTo in interface java.lang.Comparable

Parameters:

o - The other object

Returns:

The compareTo value

equals

public boolean equals(java.lang.Object obj)

Equals

Overrides:

equals in class java.lang.Object

Parameters:

obj - The other object

Returns:

True if equals; otherwise false

hashCode

public int hashCode()

Hash code

Overrides:

hashCode in class java.lang.Object

Returns:

The hash code