org.jboss.windup.tooling.data

Interface Classification

All Superinterfaces:

Serializable

public interface Classification
extends Serializable

This is a non-graph dependent analogue to ClassificationModel suitable for usage after the GraphContext itself has been closed.

Author:

Jesse Sightler

Method Summary

Modifier and Type	Method and Description
String	getClassification() Contains a description of this Classification.
String	getDescription() Contains a description of the file and any migration steps that may be necessary.
int	getEffort() This contains the effort level as an integer (Story Points).
File	getFile() This is the File that this Classification refers to.
Object	getID() Gets the unique identifier of this classification.
IssueCategory	getIssueCategory() This is a hint as to the severity of the problem.
List<Link>	getLinks() This contains a list of Links for further information about the problem and its solution.
List<Quickfix>	getQuickfixes() This contains a list of Quickfixs for follow up in tools
String	getRuleID() This contains the id of the rule that produced this Classification.

Method Detail

getID

Object getID()

Gets the unique identifier of this classification.

getFile

File getFile()

This is the File that this Classification refers to.

getClassification

String getClassification()

Contains a description of this Classification. This is similar in concept to a title, and should be one sentence or less.

getDescription

String getDescription()

Contains a description of the file and any migration steps that may be necessary.

getLinks

List<Link> getLinks()

This contains a list of Links for further information about the problem and its solution.

getQuickfixes

List<Quickfix> getQuickfixes()

This contains a list of Quickfixs for follow up in tools

Returns:

getEffort

int getEffort()

This contains the effort level as an integer (Story Points). This is based on the Scrum "modified-Fibonacci" system of effort estimation.

getIssueCategory

IssueCategory getIssueCategory()

This is a hint as to the severity of the problem. This may be used for supplying an icon or glyph in the report to the user.

getRuleID

String getRuleID()

This contains the id of the rule that produced this Classification.