com.atlassian.bitbucket.pull

Class PullRequestDiffRequest.Builder

java.lang.Object

com.atlassian.bitbucket.util.BuilderSupport

com.atlassian.bitbucket.pull.AbstractPullRequestRequest.AbstractBuilder<PullRequestDiffRequest.Builder>

com.atlassian.bitbucket.pull.PullRequestDiffRequest.Builder

Enclosing class:

PullRequestDiffRequest

public static class PullRequestDiffRequest.Builder
extends AbstractPullRequestRequest.AbstractBuilder<PullRequestDiffRequest.Builder>

Field Summary

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

NOT_BLANK

Constructor Summary

Constructors

Constructor and Description
Builder(int repositoryId, long pullRequestId, String path)
Builder(PullRequestDiffRequest request)
Builder(PullRequest pullRequest, String path)

Method Summary

Modifier and Type	Method and Description
PullRequestDiffRequest	build()
PullRequestDiffRequest.Builder	contextLines(int value) Specifies the number of context lines to include around added/removed lines.
PullRequestDiffRequest.Builder	diffType(CommentThreadDiffAnchorType value)
PullRequestDiffRequest.Builder	filter(DiffContentFilter value)
protected PullRequestDiffRequest.Builder	self()
PullRequestDiffRequest.Builder	sinceId(String value)
PullRequestDiffRequest.Builder	srcPath(String value)
PullRequestDiffRequest.Builder	untilId(String value)
PullRequestDiffRequest.Builder	whitespace(DiffWhitespace value)
PullRequestDiffRequest.Builder	withComments(boolean value) Specifies whether comments should be provided to the callback when streaming the diff.

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 Detail

Builder

public Builder(@Nonnull
               PullRequestDiffRequest request)

Builder

public Builder(@Nonnull
               PullRequest pullRequest,
               @Nullable
               String path)

Builder

public Builder(int repositoryId,
               long pullRequestId,
               @Nullable
               String path)

Method Detail

build

@Nonnull
public PullRequestDiffRequest build()

contextLines

@Nonnull
public PullRequestDiffRequest.Builder contextLines(int value)

Specifies the number of context lines to include around added/removed lines. 0 and positive values are treated as the number of lines to request. Any negative value is treated as a request for the system-configured default number of lines.

When requesting the default number of context lines, it is encouraged to use PullRequestDiffRequest.DEFAULT_CONTEXT_LINES for clarity: contextLines(DiffRequest.DEFAULT_CONTEXT_LINES).

Parameters:

value - the number of context lines to include around added and removed lines in the diff, which may be PullRequestDiffRequest.DEFAULT_CONTEXT_LINES to use the default number

Returns:

this

diffType

@Nonnull
public PullRequestDiffRequest.Builder diffType(@Nullable
                                                        CommentThreadDiffAnchorType value)

Parameters:

value - the new comment thread diff anchor type

Returns:

this

Since:

5.0

filter

@Nonnull
public PullRequestDiffRequest.Builder filter(@Nullable
                                                      DiffContentFilter value)

sinceId

@Nonnull
public PullRequestDiffRequest.Builder sinceId(@Nullable
                                                       String value)

Parameters:

value - the since ID

Returns:

this

Since:

5.0

srcPath

@Nonnull
public PullRequestDiffRequest.Builder srcPath(@Nullable
                                                       String value)

untilId

@Nonnull
public PullRequestDiffRequest.Builder untilId(@Nonnull
                                                       String value)

Parameters:

value - the new until ID

Returns:

this

Since:

5.0

whitespace

@Nonnull
public PullRequestDiffRequest.Builder whitespace(@Nonnull
                                                          DiffWhitespace value)

withComments

@Nonnull
public PullRequestDiffRequest.Builder withComments(boolean value)

Specifies whether comments should be provided to the callback when streaming the diff. When requested, comments are offered by thread to allow them to be matched to paths and line numbers in the diff as it is streamed.

Parameters:

value - true to request comments (and their threads) be provided to the callback when streaming the diff (the default); otherwise, false to omit comments

Returns:

this

self

@Nonnull
protected PullRequestDiffRequest.Builder self()

Specified by:

self in class AbstractPullRequestRequest.AbstractBuilder<PullRequestDiffRequest.Builder>