Package com.atlassian.bitbucket.codeinsights.annotation

Class SingleAddInsightAnnotationRequest.Builder

java.lang.Object

com.atlassian.bitbucket.util.BuilderSupport

com.atlassian.bitbucket.codeinsights.AbstractInsightsBuilder

com.atlassian.bitbucket.codeinsights.annotation.SingleAddInsightAnnotationRequest.Builder

Enclosing class:

SingleAddInsightAnnotationRequest

public static final class SingleAddInsightAnnotationRequest.Builder
extends AbstractInsightsBuilder

Field Summary

Fields inherited from class com.atlassian.bitbucket.util.BuilderSupport

NOT_BLANK

Constructor Summary

Constructors

Constructor	Description
Builder(int line, String message, String path)	Create a new builder to create a new annotation.
Builder(InsightAnnotation annotation)	Create a new builder to create a new annotation, setting all fields to the values of the given annotation
Builder(String message)	Create a new builder to create a new annotation.

Method Summary

Modifier and Type	Method	Description
SingleAddInsightAnnotationRequest	build()
SingleAddInsightAnnotationRequest.Builder	externalId(String value)	Id in the external system.
SingleAddInsightAnnotationRequest.Builder	line(int value)	Set the line for this annotation
SingleAddInsightAnnotationRequest.Builder	link(URI value)	Deep-link to the annotation in the application that produced it.
SingleAddInsightAnnotationRequest.Builder	message(String value)	Set the message for this annotation
SingleAddInsightAnnotationRequest.Builder	path(String value)	Set the path for this annotation.
SingleAddInsightAnnotationRequest.Builder	severity(AnnotationSeverity value)	Set the severity for this annotation.
SingleAddInsightAnnotationRequest.Builder	type(AnnotationType value)	Set the type for this annotation

Methods inherited from class com.atlassian.bitbucket.codeinsights.AbstractInsightsBuilder

validate

Methods inherited from class com.atlassian.bitbucket.util.BuilderSupport

addIf, addIf, addIf, addIf, addIf, addIf, checkNotBlank, requireNonBlank

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder(int line,
 @Nonnull
 String message,
 @Nonnull
 String path)

Create a new builder to create a new annotation. By default the annotation will be created with a LOW severity.

Parameters:

line - line in the file that this annotation applies to. Must be a value greater or equal to 0. A value of 0 indicates it is a file level annotation.

message - message for the annotation

path - relative path to the file for this this annotation applies. A blank path indicates it is a commit-level annotation.

Since:

5.15

Builder

public Builder(@Nonnull
 String message)

Create a new builder to create a new annotation. By default the annotation will be created with a LOW severity, a line of 0 and a blank path.

Parameters:

message - message for the annotation

Since:

6.7

Builder

public Builder(@Nonnull
 InsightAnnotation annotation)

Create a new builder to create a new annotation, setting all fields to the values of the given annotation

Parameters:

annotation - The annotation to create

Method Details

build

public SingleAddInsightAnnotationRequest build()

externalId

@Nonnull
public SingleAddInsightAnnotationRequest.Builder externalId(@Nullable
 String value)

Id in the external system. This is optional but if present allows for easy update/delete operations of the annotation.

Parameters:

value - external id

Returns:

the builder

line

@Nonnull
public SingleAddInsightAnnotationRequest.Builder line(int value)

Set the line for this annotation

Parameters:

value - the new line

Returns:

the builder

link

@Nonnull
public SingleAddInsightAnnotationRequest.Builder link(@Nullable
 URI value)

Deep-link to the annotation in the application that produced it.

Parameters:

value - full link to the remote tool

Returns:

the builder

message

@Nonnull
public SingleAddInsightAnnotationRequest.Builder message(@Nonnull
 String value)

Set the message for this annotation

Parameters:

value - the new message

Returns:

the builder

path

@Nonnull
public SingleAddInsightAnnotationRequest.Builder path(@Nonnull
 String value)

Set the path for this annotation.

Parameters:

value - the new path

Returns:

the builder

severity

@Nonnull
public SingleAddInsightAnnotationRequest.Builder severity(@Nonnull
 AnnotationSeverity value)

Set the severity for this annotation.

Parameters:

value - the new severity

Returns:

the builder

type

@Nonnull
public SingleAddInsightAnnotationRequest.Builder type(@Nullable
 AnnotationType value)

Set the type for this annotation

Parameters:

value - the new type

Returns:

the builder