edu.hm.hafner.analysis

Class Issue

java.lang.Object

edu.hm.hafner.analysis.Issue

All Implemented Interfaces:

Serializable

public class Issue
extends Object
implements Serializable

An issue reported by a static analysis tool. Use the provided builder to create new instances.

Author:

Ullrich Hafner

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Issue(Issue copy) Creates a new instance of Issue using the properties of the other issue instance.
protected	Issue(String fileName, int lineStart, int lineEnd, int columnStart, int columnEnd, LineRangeList lineRanges, String category, String type, String packageName, String moduleName, Severity severity, String message, String description, String origin, String reference, String fingerprint, Serializable additionalProperties) Creates a new instance of Issue using the specified properties.
protected	Issue(String fileName, int lineStart, int lineEnd, int columnStart, int columnEnd, LineRangeList lineRanges, String category, String type, String packageName, String moduleName, Severity severity, String message, String description, String origin, String reference, String fingerprint, Serializable additionalProperties, UUID id) Creates a new instance of Issue using the specified properties.

Method Summary

Modifier and Type	Method and Description
static Predicate<Issue>	byCategory(String category) Returns a predicate that checks if the category of an issue is equal to the specified category.
static Predicate<Issue>	byFileName(String fileName) Returns a predicate that checks if the file name of an issue is equal to the specified file name.
static Predicate<Issue>	byModuleName(String moduleName) Returns a predicate that checks if the module name of an issue is equal to the specified module name.
static Predicate<Issue>	byOrigin(String origin) Returns a predicate that checks if the origin of an issue is equal to the specified origin.
static Predicate<Issue>	byPackageName(String packageName) Returns a predicate that checks if the package name of an issue is equal to the specified package name.
static Predicate<Issue>	bySeverity(Severity severity) Returns a predicate that checks if the severity of an issue is equal to the specified severity.
static Predicate<Issue>	byType(String type) Returns a predicate that checks if the type of an issue is equal to the specified type.
boolean	equals(Object o)
Serializable	getAdditionalProperties() Returns additional properties for this issue.
String	getBaseName() Returns the base name of the file that contains this issue (i.e. the file name without the full path).
String	getCategory() Returns the category of this issue (depends on the available categories of the static analysis tool).
int	getColumnEnd() Returns the last column of this issue (columns start at 1).
int	getColumnStart() Returns the first column of this issue (columns start at 1, 0 indicates the whole line).
String	getDescription() Returns an additional description for this issue.
String	getFileName() Returns the name of the file that contains this issue.
String	getFingerprint() Returns the finger print for this issue.
UUID	getId() Returns the unique ID of this issue.
int	getLineEnd() Returns the last line of this issue (lines start at 1).
LineRangeList	getLineRanges() Returns additional line ranges for this issue.
int	getLineStart() Returns the first line of this issue (lines start at 1; 0 indicates the whole file).
String	getMessage() Returns the detailed message for this issue.
String	getModuleName() Returns the name of the module or project (or similar concept) that contains this issue.
String	getOrigin() Returns the ID of the tool that did report this issue.
String	getPackageName() Returns the name of the package or name space (or similar concept) that contains this issue.
static String	getPropertyValueAsString(Issue issue, String propertyName) Returns the value of the property with the specified name for a given issue instance.
static Function<Issue,String>	getPropertyValueGetter(String propertyName) Returns a function that can dynamically obtain the value of the property with the specified name of an issue instance.
String	getReference() Returns a reference to the execution of the static analysis tool (build ID, timestamp, etc.).
Severity	getSeverity() Returns the severity of this issue.
String	getType() Returns the type of this issue (depends on the available types of the static analysis tool).
boolean	hasFileName() Returns whether this issue has a file name set.
boolean	hasFingerprint() Returns whether this issue already has a fingerprint set.
int	hashCode()
boolean	hasModuleName() Returns whether this issue has a module name set.
boolean	hasPackageName() Returns whether this issue has a package name set.
protected Object	readResolve() Called after de-serialization to improve the memory usage.
void	setFileName(String fileName) Sets the name of the file that contains this issue.
void	setFingerprint(String fingerprint) Sets the finger print for this issue to the given value.
void	setModuleName(String moduleName) Sets the the name of the module or project (or similar concept) that contains this issue.
void	setOrigin(String origin) Sets the ID of the tool that did report this issue.
void	setPackageName(String packageName) Sets the name of the package or name space (or similar concept) that contains this issue.
void	setReference(String reference) Sets a reference to the execution of the static analysis tool (build ID, timestamp, etc.).
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Issue

protected Issue(Issue copy)

Creates a new instance of Issue using the properties of the other issue instance. The new issue has the same ID as the copy.

Parameters:

copy - the other issue to copy the properties from

Issue

protected Issue(@CheckForNull
                String fileName,
                int lineStart,
                int lineEnd,
                int columnStart,
                int columnEnd,
                @CheckForNull
                LineRangeList lineRanges,
                @CheckForNull
                String category,
                @CheckForNull
                String type,
                @CheckForNull
                String packageName,
                @CheckForNull
                String moduleName,
                @CheckForNull
                Severity severity,
                @CheckForNull
                String message,
                @CheckForNull
                String description,
                @CheckForNull
                String origin,
                @CheckForNull
                String reference,
                @CheckForNull
                String fingerprint,
                @CheckForNull
                Serializable additionalProperties)

Creates a new instance of Issue using the specified properties. The new issue will get a new generated ID.

Parameters:

fileName - the name of the file that contains this issue

lineStart - the first line of this issue (lines start at 1; 0 indicates the whole file)

lineEnd - the last line of this issue (lines start at 1)

columnStart - the first column of this issue (columns start at 1, 0 indicates the whole line)

columnEnd - the last column of this issue (columns start at 1)

lineRanges - additional line ranges of this issue

category - the category of this issue (depends on the available categories of the static analysis tool)

type - the type of this issue (depends on the available types of the static analysis tool)

packageName - the name of the package (or name space) that contains this issue

moduleName - the name of the moduleName (or project) that contains this issue

severity - the severity of this issue

message - the detail message of this issue

description - the description for this issue

origin - the ID of the tool that did report this issue

reference - an arbitrary reference to the execution of the static analysis tool (build ID, timestamp, etc.)

fingerprint - the finger print for this issue

additionalProperties - additional properties from the statical analysis tool

Issue

protected Issue(@CheckForNull
                String fileName,
                int lineStart,
                int lineEnd,
                int columnStart,
                int columnEnd,
                @CheckForNull
                LineRangeList lineRanges,
                @CheckForNull
                String category,
                @CheckForNull
                String type,
                @CheckForNull
                String packageName,
                @CheckForNull
                String moduleName,
                @CheckForNull
                Severity severity,
                @CheckForNull
                String message,
                @CheckForNull
                String description,
                @CheckForNull
                String origin,
                @CheckForNull
                String reference,
                @CheckForNull
                String fingerprint,
                @CheckForNull
                Serializable additionalProperties,
                UUID id)

Creates a new instance of Issue using the specified properties.

Parameters:

fileName - the name of the file that contains this issue

lineStart - the first line of this issue (lines start at 1; 0 indicates the whole file)

lineEnd - the last line of this issue (lines start at 1)

columnStart - the first column of this issue (columns start at 1, 0 indicates the whole line)

columnEnd - the last column of this issue (columns start at 1)

lineRanges - additional line ranges of this issue

category - the category of this issue (depends on the available categories of the static analysis tool)

type - the type of this issue (depends on the available types of the static analysis tool)

packageName - the name of the package (or name space) that contains this issue

moduleName - the name of the moduleName (or project) that contains this issue

severity - the severity of this issue

message - the detail message of this issue

description - the description for this issue

origin - the ID of the tool that did report this issue

reference - an arbitrary reference to the execution of the static analysis tool (build ID, timestamp, etc.)

fingerprint - the finger print for this issue

additionalProperties - additional properties from the statical analysis tool

id - the ID of this issue

Method Detail

getPropertyValueAsString

public static String getPropertyValueAsString(Issue issue,
                                              String propertyName)

Returns the value of the property with the specified name for a given issue instance.

Parameters:

issue - the issue to get the property for

propertyName - the name of the property

Returns:

the function that obtains the value

getPropertyValueGetter

public static Function<Issue,String> getPropertyValueGetter(String propertyName)

Returns a function that can dynamically obtain the value of the property with the specified name of an issue instance.

Parameters:

propertyName - the name of the property

Returns:

the function that obtains the value

byPackageName

public static Predicate<Issue> byPackageName(String packageName)

Returns a predicate that checks if the package name of an issue is equal to the specified package name.

Parameters:

packageName - the package name to match

Returns:

the predicate

byModuleName

public static Predicate<Issue> byModuleName(String moduleName)

Returns a predicate that checks if the module name of an issue is equal to the specified module name.

Parameters:

moduleName - the module name to match

Returns:

the predicate

byFileName

public static Predicate<Issue> byFileName(String fileName)

Returns a predicate that checks if the file name of an issue is equal to the specified file name.

Parameters:

fileName - the file name to match

Returns:

the predicate

bySeverity

public static Predicate<Issue> bySeverity(Severity severity)

Returns a predicate that checks if the severity of an issue is equal to the specified severity.

Parameters:

severity - the severity to match

Returns:

the predicate

byCategory

public static Predicate<Issue> byCategory(String category)

Returns a predicate that checks if the category of an issue is equal to the specified category.

Parameters:

category - the category to match

Returns:

the predicate

byOrigin

public static Predicate<Issue> byOrigin(String origin)

Returns a predicate that checks if the origin of an issue is equal to the specified origin.

Parameters:

origin - the origin to match

Returns:

the predicate

byType

public static Predicate<Issue> byType(String type)

Returns a predicate that checks if the type of an issue is equal to the specified type.

Parameters:

type - the type to match

Returns:

the predicate

readResolve

protected Object readResolve()

Called after de-serialization to improve the memory usage.

Returns:

this

getId

public UUID getId()

Returns the unique ID of this issue.

Returns:

the unique ID

getFileName

public String getFileName()

Returns the name of the file that contains this issue. Typically this file name is the absolute name.

Returns:

the name of the file that contains this issue

getBaseName

public String getBaseName()

Returns the base name of the file that contains this issue (i.e. the file name without the full path).

Returns:

the base name of the file that contains this issue

setFileName

public void setFileName(@CheckForNull
                        String fileName)

Sets the name of the file that contains this issue.

Parameters:

fileName - the file name to set

hasFileName

public boolean hasFileName()

Returns whether this issue has a file name set.

Returns:

true if this issue has a file name set

See Also:

getFileName()

getCategory

public String getCategory()

Returns the category of this issue (depends on the available categories of the static analysis tool). Examples for categories are "Deprecation", "Design", or "JavaDoc".

Returns:

the category

getType

public String getType()

Returns the type of this issue (depends on the available types of the static analysis tool). The type typically is the associated rule of the static analysis tool that reported this issue.

Returns:

the type

getSeverity

public Severity getSeverity()

Returns the severity of this issue.

Returns:

the severity

getMessage

public String getMessage()

Returns the detailed message for this issue.

Returns:

the message

getDescription

public String getDescription()

Returns an additional description for this issue. Static analysis tools might provide some additional information about this issue. This description may contain valid HTML.

Returns:

the description

getLineStart

public int getLineStart()

Returns the first line of this issue (lines start at 1; 0 indicates the whole file).

Returns:

the first line

getLineEnd

public int getLineEnd()

Returns the last line of this issue (lines start at 1).

Returns:

the last line

getLineRanges

public LineRangeList getLineRanges()

Returns additional line ranges for this issue. Not that the primary range given by lineStart and lineEnd is not included.

Returns:

the last line

getColumnStart

public int getColumnStart()

Returns the first column of this issue (columns start at 1, 0 indicates the whole line).

Returns:

the first column

getColumnEnd

public int getColumnEnd()

Returns the last column of this issue (columns start at 1).

Returns:

the last column

getPackageName

public String getPackageName()

Returns the name of the package or name space (or similar concept) that contains this issue.

Returns:

the package name

setPackageName

public void setPackageName(@CheckForNull
                           String packageName)

Sets the name of the package or name space (or similar concept) that contains this issue.

Parameters:

packageName - the name of the package

hasPackageName

public boolean hasPackageName()

Returns whether this issue has a package name set.

Returns:

true if this issue has a package name set

See Also:

getPackageName()

getModuleName

public String getModuleName()

Returns the name of the module or project (or similar concept) that contains this issue.

Returns:

the module

setModuleName

public void setModuleName(@CheckForNull
                          String moduleName)

Sets the the name of the module or project (or similar concept) that contains this issue.

Parameters:

moduleName - the module name to set

hasModuleName

public boolean hasModuleName()

Returns whether this issue has a module name set.

Returns:

true if this issue has a module name set

See Also:

getModuleName()

getOrigin

public String getOrigin()

Returns the ID of the tool that did report this issue.

Returns:

the origin

setOrigin

public void setOrigin(String origin)

Sets the ID of the tool that did report this issue.

Parameters:

origin - the origin

getReference

public String getReference()

Returns a reference to the execution of the static analysis tool (build ID, timestamp, etc.).

Returns:

the reference

setReference

public void setReference(@CheckForNull
                         String reference)

Sets a reference to the execution of the static analysis tool (build ID, timestamp, etc.).

Parameters:

reference - the reference

getFingerprint

public String getFingerprint()

Returns the finger print for this issue. Used to decide if two issues are equal even if the equals method returns false since some of the properties differ due to code refactorings. The fingerprint is created by analyzing the content of the affected file.

Note: the fingerprint is not part of the equals method since the fingerprint might change due to an unrelated refactoring of the source code.

Returns:

the fingerprint of this issue

setFingerprint

public void setFingerprint(@CheckForNull
                           String fingerprint)

Sets the finger print for this issue to the given value.

Parameters:

fingerprint - the fingerprint to set

See Also:

getFingerprint()

hasFingerprint

public boolean hasFingerprint()

Returns whether this issue already has a fingerprint set.

Returns:

true if this issue already has a fingerprint set

getAdditionalProperties

@CheckForNull
public Serializable getAdditionalProperties()

Returns additional properties for this issue. A static analysis tool may store additional properties in this untyped object. This object will be serialized and is used in equals and hashCode.

Returns:

the additional properties

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object