org.jcoderz.phoenix.report
Class FindingType

java.lang.Object
  org.jcoderz.phoenix.report.FindingType

Direct Known Subclasses:

CheckstyleFindingType, CpdFindingType, FindBugsFindingType, GenericFindingType, PmdFindingType, SystemFindingType

public class FindingType
extends Object

Base class identifies the unique type of a finding.

Author:

Andreas Mandel

Nested Class Summary

protected static class

FindingType.LazyInit

Constructor Summary

protected

FindingType(String symbol, String shortText, String description)

Method Summary

boolean	equals(Object o)
static FindingType	fromString(String symbol) Retrieves the finding type based on it's symbol.
String	getDescription() Returns a long description of this finding type.
String	getShortText() Returns the short text description of this finding type.
String	getSymbol() Returns the symbol of this finding type.
int	hashCode()
static void	initialize(Origin origin) Initializes the findings with the given origin.
String	toString() Returns the finding type symbol as its string representation.

Methods inherited from class java.lang.Object

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

Constructor Detail

FindingType

protected FindingType(String symbol,
                      String shortText,
                      String description)

Method Detail

fromString

public static FindingType fromString(String symbol)

Retrieves the finding type based on it's symbol.

Parameters:

symbol - the symbol to look up.

Returns:

the findings type that holds the given symbol.

initialize

public static void initialize(Origin origin)

Initializes the findings with the given origin.

Parameters:

origin - the class of findings to be initialized.

getSymbol

public String getSymbol()

Returns the symbol of this finding type.

Returns:

the symbol of this finding type.

getShortText

public String getShortText()

Returns the short text description of this finding type. Should be a one liner.

Returns:

the short text description of this finding type.

getDescription

public String getDescription()

Returns a long description of this finding type. Might contain html markup.

Returns:

the long description of this finding type.

toString

public String toString()

Returns the finding type symbol as its string representation.

Overrides:

toString in class Object

Returns:

the finding type symbol as its string representation.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object