Package jetbrains.buildServer.agent.inspections

Class InspectionInstance

java.lang.Object

jetbrains.buildServer.agent.inspections.InspectionInstance

public class InspectionInstance
extends Object

Concrete defect, warning, error message Encapsulates location, description and various attributes

Constructor Summary

Constructors

Constructor	Description
InspectionInstance()

Method Summary

Modifier and Type	Method	Description
void	addAttribute(String attributeId, Collection<String> value)	Adds inspection additional information as map of attribute ids to values, were attribute ids predefined and values given as list of strings to help TeamCity match it by prefix
Map<String,List<String>>	getAttributes()	Get current attributes map
String	getFilePath()	Gets file path
String	getInspectionId()	Gets inspection type id
int	getLine()
String	getMessage()	Gets current instance description
void	setFilePath(String filePath)	Sets file path inspection instance corresponds to
void	setInspectionId(String inspectionId)	Sets inspection type id.
void	setLine(int line)	Sets line of file
void	setMessage(String message)	Sets current instance description.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

InspectionInstance

public InspectionInstance()

Method Detail

getMessage

public String getMessage()

Gets current instance description

Returns:

description

setMessage

public void setMessage(String message)

Sets current instance description. i.e. "Unused function 'getParam'"

Required

getInspectionId

public String getInspectionId()

Gets inspection type id

setInspectionId

public void setInspectionId(String inspectionId)

Sets inspection type id. Same as InspectionTypeInfo's id

See Also:

Required

getFilePath

public String getFilePath()

Gets file path

setFilePath

public void setFilePath(String filePath)

Sets file path inspection instance corresponds to

Required

getLine

public int getLine()

Returns:

line of file

setLine

public void setLine(int line)

Sets line of file

Optional

addAttribute

public void addAttribute(String attributeId,
                         Collection<String> value)

Adds inspection additional information as map of attribute ids to values, were attribute ids predefined and values given as list of strings to help TeamCity match it by prefix

See Also:

example: PACKAGE = 'com' 'intellij' 'teamcity' 'some-package'

getAttributes

@NotNull
public Map<String,List<String>> getAttributes()

Get current attributes map

Returns:

attributes map

toString

public String toString()

Overrides:

toString in class Object