org.jboss.windup.reporting.config.classification

Class Classification

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<FileModel>

org.jboss.windup.reporting.config.classification.Classification

All Implemented Interfaces:

ClassificationAs, ClassificationDescription, ClassificationEffort, ClassificationLink, ClassificationQuickfix, ClassificationTags, ClassificationWithIssueCategory, ClassificationWithIssueDisplayMode, org.ocpsoft.rewrite.config.Operation, org.ocpsoft.rewrite.config.OperationBuilder, org.ocpsoft.rewrite.param.Parameterized

public class Classification
extends ParameterizedIterationOperation<FileModel>
implements ClassificationAs, ClassificationEffort, ClassificationDescription, ClassificationLink, ClassificationTags, ClassificationWithIssueCategory, ClassificationQuickfix, ClassificationWithIssueDisplayMode

Classifies a FileModel Iteration payload.

Author:

Lincoln Baxter, III, Ondrej Zizka

Method Summary

Modifier and Type	Method and Description
static ClassificationAs	as(String classification) Classify the current FileModel as the given text.
org.ocpsoft.rewrite.param.RegexParameterizedPatternParser	getClassificationPattern()
org.ocpsoft.rewrite.param.RegexParameterizedPatternParser	getDescriptionPattern()
int	getEffort()
IssueCategory	getIssueCategory() Gets the configured IssueCategory level.
List<Link>	getLinks()
List<Quickfix>	getQuickfixes()
Set<String>	getRequiredParameterNames()
static ClassificationBuilderOf	of(String variable) Create a new classification for the given ref.
void	performParameterized(GraphRewrite event, org.ocpsoft.rewrite.context.EvaluationContext context, FileModel payload)
FileModel	resolvePayload(GraphRewrite event, org.ocpsoft.rewrite.context.EvaluationContext context, WindupVertexFrame payload) Set the payload to the fileModel of the given instance even though the variable is not directly referencing it.
protected void	setClassificationText(String classification)
void	setParameterStore(org.ocpsoft.rewrite.param.ParameterStore store)
String	toString()
ClassificationLink	with(Link link) Add a Link to this Classification.
ClassificationDescription	withDescription(String description) Set the description of this Classification.
Classification	withEffort(int effort) Specify the effort that that represents the level of effort required to fix the object.
ClassificationWithIssueCategory	withIssueCategory(IssueCategory issueCategory) Sets the IssueCategory to a non-default level.
ClassificationWithIssueDisplayMode	withIssueDisplayMode(IssueDisplayMode issueDisplayMode) Sets the IssueDisplayMode.
ClassificationQuickfix	withQuickfix(Quickfix fix) Specify the quickfix describing the topic more precisely.
ClassificationTags	withTags(Set<String> tags) Add the given tags to this Classification.

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, 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

Method Detail

of

public static ClassificationBuilderOf of(String variable)

Create a new classification for the given ref.

as

public static ClassificationAs as(String classification)

Classify the current FileModel as the given text.

getQuickfixes

public List<Quickfix> getQuickfixes()

Returns:

the quickfixes

resolvePayload

public FileModel resolvePayload(GraphRewrite event,
                                org.ocpsoft.rewrite.context.EvaluationContext context,
                                WindupVertexFrame payload)

Set the payload to the fileModel of the given instance even though the variable is not directly referencing it. This is mainly to simplify the creation of the rule, when the FileModel itself is not being iterated but just a model referencing it.

Overrides:

resolvePayload in class AbstractIterationOperation<FileModel>

getIssueCategory

public IssueCategory getIssueCategory()

Gets the configured IssueCategory level.

withIssueCategory

public ClassificationWithIssueCategory withIssueCategory(IssueCategory issueCategory)

Sets the IssueCategory to a non-default level.

Specified by:

withIssueCategory in interface ClassificationDescription

withIssueDisplayMode

public ClassificationWithIssueDisplayMode withIssueDisplayMode(IssueDisplayMode issueDisplayMode)

Description copied from interface: ClassificationWithIssueCategory

Sets the IssueDisplayMode.

Specified by:

withIssueDisplayMode in interface ClassificationWithIssueCategory

withDescription

public ClassificationDescription withDescription(String description)

Set the description of this Classification.

Specified by:

withDescription in interface ClassificationAs

Parameters:

description - description of the classification. If you want to specify description. specify it in this step.

Returns:

next step of Classification definition

with

public ClassificationLink with(Link link)

Add a Link to this Classification.

Specified by:

with in interface ClassificationAs

Specified by:

with in interface ClassificationDescription

Specified by:

with in interface ClassificationLink

Specified by:

with in interface ClassificationWithIssueCategory

Specified by:

with in interface ClassificationWithIssueDisplayMode

Parameters:

link - the Link describing the topic more precisely

Returns:

next step of Classification definition

See Also:

ClassificationAs.with(Link)

withQuickfix

public ClassificationQuickfix withQuickfix(Quickfix fix)

Description copied from interface: ClassificationQuickfix

Specify the quickfix describing the topic more precisely.

Specified by:

withQuickfix in interface ClassificationQuickfix

Returns:

next step of Classification definition to specify effort

withTags

public ClassificationTags withTags(Set<String> tags)

Add the given tags to this Classification.

Specified by:

withTags in interface ClassificationLink

Specified by:

withTags in interface ClassificationTags

Returns:

next step of Classification definition to specify effort

withEffort

public Classification withEffort(int effort)

Description copied from interface: ClassificationAs

Specify the effort that that represents the level of effort required to fix the object. Use this only if you don't want to specify description nor any extra link.

Specified by:

withEffort in interface ClassificationAs

Specified by:

withEffort in interface ClassificationDescription

Specified by:

withEffort in interface ClassificationLink

Specified by:

withEffort in interface ClassificationQuickfix

Specified by:

withEffort in interface ClassificationTags

Specified by:

withEffort in interface ClassificationWithIssueCategory

Specified by:

withEffort in interface ClassificationWithIssueDisplayMode

Parameters:

effort - Effort needed to be put. Will be used to count story points for the whole application.

Returns:

next step of Classification definition

See Also:

ClassificationAs.withEffort(int)

performParameterized

public void performParameterized(GraphRewrite event,
                                 org.ocpsoft.rewrite.context.EvaluationContext context,
                                 FileModel payload)

Specified by:

performParameterized in class ParameterizedIterationOperation<FileModel>

setClassificationText

protected void setClassificationText(String classification)

toString

public String toString()

Overrides:

toString in class AbstractIterationOperation<FileModel>

getLinks

public List<Link> getLinks()

getClassificationPattern

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

getDescriptionPattern

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

getEffort

public int getEffort()

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