org.jcoderz.phoenix.report
Class GenericFindingType

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

public final class GenericFindingType
extends FindingType

Enumeration type for generic findings. The description and patterns are read from a xml file.

Author:

Andreas Mandel

Nested Class Summary

static class

GenericFindingType.OrderByPriority Class to sort GenericFindingTypes by their priority.

Nested classes/interfaces inherited from class org.jcoderz.phoenix.report.FindingType

FindingType.LazyInit

Constructor Summary

GenericFindingType(FindingDescription root, FindingDescription fd)
Create new finding type based on xml description.

Method Summary

Item	createItem(org.jcoderz.phoenix.report.GenericReportReader.SourceFile sf, String message) Try to match the given method and fill the item accordingly if a match is found.
Severity	getSeverity()
static void	initialize() Init of the enum.
boolean	isGlobal()
boolean	isSourceColumnByCaret()

Methods inherited from class org.jcoderz.phoenix.report.FindingType

equals, fromString, getDescription, getShortText, getSymbol, hashCode, initialize, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericFindingType

public GenericFindingType(FindingDescription root,
                          FindingDescription fd)

Create new finding type based on xml description.

Parameters:

root - the definition of the root finding description.

fd - the definition of the detailed finding description.

Method Detail

createItem

public Item createItem(org.jcoderz.phoenix.report.GenericReportReader.SourceFile sf,
                       String message)
                throws JAXBException

Try to match the given method and fill the item accordingly if a match is found.

Parameters:

sf - the input source read. Allows to set the new file position.

message - the message to parse.

Returns:

a new Item with available data filled or null.

Throws:

JAXBException - if Item creation fails on jaxb level.

getSeverity

public Severity getSeverity()

Returns:

the severity assigned to findings of this type by default.

isSourceColumnByCaret

public boolean isSourceColumnByCaret()

Returns:

the sourceColumnByCaret

isGlobal

public boolean isGlobal()

Returns:

the isGlobal

initialize

public static void initialize()

Init of the enum.