com.atlassian.stash.rest.client.api.entity

Class CodeAnnotation

java.lang.Object

com.atlassian.stash.rest.client.api.entity.CodeAnnotation

public class CodeAnnotation
extends Object

Represents a single code annotation belonging to a single Report for a particular file.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CodeAnnotation.Severity Severity of the problem.
static class	CodeAnnotation.Type Type of the problem.

Constructor Summary

Constructors

Constructor and Description
CodeAnnotation(String reportKey, String externalId, CodeAnnotation.Severity severity, String message, String path, Integer line, String link, CodeAnnotation.Type type)

Method Summary

Modifier and Type	Method and Description
String	getExternalId() Unique externally managed Id of the annotation.
Integer	getLine() Line number in the file from getPath().
String	getLink() External link for the code annotation (tool report, vendor page, etc.).
String	getMessage() Message associated with this code annotation.
String	getPath() Path in the repository for the file to which the annotation applies.
String	getReportKey() Key of the Report to which this code annotation belongs.
CodeAnnotation.Severity	getSeverity() Tells how severe the problem described by this code annotation is.
CodeAnnotation.Type	getType() Tells the type of the problem described by this code annotation.

Methods inherited from class java.lang.Object

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

Constructor Detail

CodeAnnotation

public CodeAnnotation(@Nonnull
                      String reportKey,
                      @Nullable
                      String externalId,
                      @Nonnull
                      CodeAnnotation.Severity severity,
                      @Nonnull
                      String message,
                      @Nonnull
                      String path,
                      @Nullable
                      Integer line,
                      @Nullable
                      String link,
                      @Nullable
                      CodeAnnotation.Type type)

Method Detail

getReportKey

@Nonnull
public String getReportKey()

Key of the Report to which this code annotation belongs.

getExternalId

@Nullable
public String getExternalId()

Unique externally managed Id of the annotation. Optional. Arbitrarily assigned during annotation creation.

getSeverity

@Nonnull
public CodeAnnotation.Severity getSeverity()

Tells how severe the problem described by this code annotation is.

getMessage

@Nonnull
public String getMessage()

Message associated with this code annotation.

getPath

@Nonnull
public String getPath()

Path in the repository for the file to which the annotation applies.

getLine

@Nullable
public Integer getLine()

Line number in the file from getPath(). If not provided, the annotation applies to the entire file.

getLink

@Nullable
public String getLink()

External link for the code annotation (tool report, vendor page, etc.).

getType

@Nullable
public CodeAnnotation.Type getType()

Tells the type of the problem described by this code annotation.