org.jenkinsci.plugins.cflint.parser
Class LintAnnotation

java.lang.Object
  hudson.plugins.analysis.util.model.AbstractAnnotation
      org.jenkinsci.plugins.cflint.parser.LintAnnotation

All Implemented Interfaces:

hudson.plugins.analysis.util.model.FileAnnotation, Serializable, Comparable<hudson.plugins.analysis.util.model.FileAnnotation>

public class LintAnnotation
extends hudson.plugins.analysis.util.model.AbstractAnnotation

An analysis-core Annotation representing a potential bug as determined by Lint.

See Also:

Serialized Form

Field Summary

Fields inherited from class hudson.plugins.analysis.util.model.AbstractAnnotation

WORKSPACE_FILES

Constructor Summary

LintAnnotation(hudson.plugins.analysis.util.model.Priority priority, String message, String category, String type, int lineNumber)
Constructor.

Method Summary

void	addLocation(Location location) Adds an additional location where this issue occurs.
List<String>	getErrorLines()
Collection<Location>	getLocations()
String	getToolTip()
void	setErrorLines(String... lines) Sets the error lines for this issue.
void	setExplanation(String explanation)

Methods inherited from class hudson.plugins.analysis.util.model.AbstractAnnotation

addLineRange, canDisplayFile, compareTo, equals, getCategory, getContextHashCode, getFileName, getKey, getLineRanges, getLinkLineNumber, getLinkName, getMessage, getModuleName, getOrigin, getPackageName, getPathName, getPrimaryLineNumber, getPriority, getShortFileName, getTempName, getType, hashCode, hasPackageName, intern, intern, setColumnPosition, setContextHashCode, setFileName, setModuleName, setOrigin, setPackageName, setPathName, setPriority, superReadResolve, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

LintAnnotation

public LintAnnotation(hudson.plugins.analysis.util.model.Priority priority,
                      String message,
                      String category,
                      String type,
                      int lineNumber)

Constructor.

Parameters:

priority - Priority of this bug.

message - Describes exactly what the bug is.

category - Bug categorisation.

type - Type within the category

lineNumber - Line number the bug starts on.

Method Detail

setExplanation

public void setExplanation(String explanation)

Parameters:

explanation - An explanation of the Lint rule violated.

setErrorLines

public void setErrorLines(String... lines)

Sets the error lines for this issue.

getErrorLines

public List<String> getErrorLines()

Returns:

A list of locations where the issue occurs.

addLocation

public void addLocation(Location location)

Adds an additional location where this issue occurs.

Parameters:

location - A location of this issue.

getLocations

public Collection<Location> getLocations()

Returns:

A list of locations (beyond the one specified by AbstractAnnotation.getFileName()) where the issue occurs.

getToolTip

public String getToolTip()