Package org.jboss.windup.tooling.data

Interface Hint

  • All Superinterfaces:
    Serializable
    public interface Hint
extends Serializable
    This is equivalent to a InlineHintModel, however it contains no dependencies on having an open instance of the graph in order to operate.
    Author:
    Jesse Sightler

    • Method Detail

      • getID

        Object getID()
        Contains a unique identifier for this hint.

      • getFile

        File getFile()
        This references the File referenced by this Hint.

      • getTitle

        String getTitle()
        Contains a title for this hint. This should describe the problem itself (for example, "Usage of proprietary class: Foo")

      • getHint

        String getHint()
        This contains descriptive text describing the problem and how the problem can be solved.

      • 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.

      • 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.

      • getLinks

        List<Link> getLinks()
        This contains a list of Links for further information about the problem and its solution.

      • getLineNumber

        int getLineNumber()
        This contains the line number of the problem.

      • getColumn

        int getColumn()
        This contains the column number within that line.

      • getLength

        int getLength()
        This contains the length of the code section being referenced. For example, if the original code was "f.a()", this would be be "5".

      • getSourceSnippit

        String getSourceSnippit()
        This contains the original source code itself (for example, "proprietaryobject.doStuff()").