org.jboss.windup.reporting.config

Class Hint

java.lang.Object

org.ocpsoft.rewrite.config.DefaultOperationBuilder

org.jboss.windup.config.operation.GraphOperation

org.jboss.windup.config.operation.iteration.AbstractIterationOperation<T>

org.jboss.windup.config.parameters.ParameterizedIterationOperation<FileLocationModel>

org.jboss.windup.reporting.config.Hint

All Implemented Interfaces:

HintDisplayMode, HintEffort, HintLink, HintQuickfix, HintText, HintWithIssueCategory, org.ocpsoft.rewrite.config.Operation, org.ocpsoft.rewrite.config.OperationBuilder, org.ocpsoft.rewrite.param.Parameterized

public class Hint
extends ParameterizedIterationOperation<FileLocationModel>
implements HintText, HintLink, HintWithIssueCategory, HintEffort, HintQuickfix, HintDisplayMode

Used as an intermediate to support the addition of InlineHintModel objects to the graph via an Operation.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Hint()
protected	Hint(String variable)

Method Summary

Modifier and Type	Method and Description
int	getEffort()
org.ocpsoft.rewrite.param.RegexParameterizedPatternParser	getHintText()
IssueCategory	getIssueCategory() Returns the currently set IssueCategory.
List<Link>	getLinks()
List<Quickfix>	getQuickfixes()
Set<String>	getRequiredParameterNames()
Set<String>	getTags()
static HintBuilderIn	in(String fileVariable) Create a new Hint in the FileLocationModel resolved by the given variable.
void	performParameterized(GraphRewrite event, org.ocpsoft.rewrite.context.EvaluationContext context, FileLocationModel locationModel)
void	setParameterStore(org.ocpsoft.rewrite.param.ParameterStore store)
protected void	setText(String text) Set the inner hint text on this instance.
protected void	setTitle(String title)
static HintBuilderTitle	titled(String title) Create a new Hint with the specified title.
String	toString()
HintLink	with(Link link) Provide a link describing the topic more precisely
HintText	withDisplayMode(IssueDisplayMode displayMode) Sets the IssueDisplayMode for this issue.
HintEffort	withEffort(int effort) Adds effort to the Hint.
HintWithIssueCategory	withIssueCategory(IssueCategory issueCategory) Specifies the IssueCategory.
HintQuickfix	withQuickfix(Quickfix quickfix) Provide quickfix for later tooling or other processing
org.ocpsoft.rewrite.config.OperationBuilder	withTags(Set<String> tags) Adds a tag to the Hint.
static HintText	withText(String text) Create a new Hint in the current FileLocationModel, and specify the text or content to be displayed in the report.

Methods inherited from class org.jboss.windup.config.parameters.ParameterizedIterationOperation

perform, perform

Methods inherited from class org.jboss.windup.config.operation.iteration.AbstractIterationOperation

camelCase, checkVariableName, getVariableName, hasVariableNameSet, resolvePayload, resolveVariable, setVariableName

Methods inherited from class org.jboss.windup.config.operation.GraphOperation

perform

Methods inherited from class org.ocpsoft.rewrite.config.DefaultOperationBuilder

and

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.ocpsoft.rewrite.config.OperationBuilder

and

Methods inherited from interface org.ocpsoft.rewrite.config.Operation

perform

Constructor Detail

Hint

protected Hint(String variable)

Hint

protected Hint()

Method Detail

in

public static HintBuilderIn in(String fileVariable)

Create a new Hint in the FileLocationModel resolved by the given variable.

titled

public static HintBuilderTitle titled(String title)

Create a new Hint with the specified title.

withText

public static HintText withText(String text)

Create a new Hint in the current FileLocationModel, and specify the text or content to be displayed in the report.

withIssueCategory

public HintWithIssueCategory withIssueCategory(IssueCategory issueCategory)

Description copied from interface: HintText

Specifies the IssueCategory.

Specified by:

withIssueCategory in interface HintText

withDisplayMode

public HintText withDisplayMode(IssueDisplayMode displayMode)

Description copied from interface: HintText

Sets the IssueDisplayMode for this issue.

Specified by:

withDisplayMode in interface HintText

getIssueCategory

public IssueCategory getIssueCategory()

Returns the currently set IssueCategory.

performParameterized

public void performParameterized(GraphRewrite event,
                                 org.ocpsoft.rewrite.context.EvaluationContext context,
                                 FileLocationModel locationModel)

Specified by:

performParameterized in class ParameterizedIterationOperation<FileLocationModel>

withEffort

public HintEffort withEffort(int effort)

Description copied from interface: HintText

Adds effort to the Hint. The effort represents the level of effort required to fix a task. Use this only if you do not want to specify the link, otherwise you will specify the effort later.

Specified by:

withEffort in interface HintDisplayMode

Specified by:

withEffort in interface HintLink

Specified by:

withEffort in interface HintQuickfix

Specified by:

withEffort in interface HintText

Specified by:

withEffort in interface HintWithIssueCategory

Parameters:

effort - number of effort to be added to hint

Returns:

the final stage of hint building

withTags

public org.ocpsoft.rewrite.config.OperationBuilder withTags(Set<String> tags)

Description copied from interface: HintEffort

Adds a tag to the Hint. Tag represents a technology which given hint describes. For example: java-ee-6, jpa-2, jpa, jms, websphere.

Specified by:

withTags in interface HintEffort

Specified by:

withTags in interface HintText

with

public HintLink with(Link link)

Description copied from interface: HintText

Provide a link describing the topic more precisely

Specified by:

with in interface HintDisplayMode

Specified by:

with in interface HintText

Specified by:

with in interface HintWithIssueCategory

Parameters:

link - the link to be added to the Hint

Returns:

the next step in building the Hint operation

setText

protected void setText(String text)

Set the inner hint text on this instance.

setTitle

protected void setTitle(String title)

getHintText

public org.ocpsoft.rewrite.param.RegexParameterizedPatternParser getHintText()

getEffort

public int getEffort()

getLinks

public List<Link> getLinks()

getTags

public Set<String> getTags()

getRequiredParameterNames

public Set<String> getRequiredParameterNames()

Specified by:

getRequiredParameterNames in interface org.ocpsoft.rewrite.param.Parameterized

setParameterStore

public void setParameterStore(org.ocpsoft.rewrite.param.ParameterStore store)

Specified by:

setParameterStore in interface org.ocpsoft.rewrite.param.Parameterized

toString

public String toString()

Overrides:

toString in class AbstractIterationOperation<FileLocationModel>

getQuickfixes

public List<Quickfix> getQuickfixes()

Returns:

the quickfixes

withQuickfix

public HintQuickfix withQuickfix(Quickfix quickfix)

Description copied from interface: HintText

Provide quickfix for later tooling or other processing

Specified by:

withQuickfix in interface HintQuickfix

Specified by:

withQuickfix in interface HintText

Parameters:

quickfix - the quickfixes to set

Returns: