com.atlassian.bitbucket.content

Class DiffRequest.Builder

java.lang.Object

com.atlassian.bitbucket.util.BuilderSupport

com.atlassian.bitbucket.content.AbstractDiffRequest.AbstractBuilder<DiffRequest.Builder,DiffRequest>

com.atlassian.bitbucket.content.DiffRequest.Builder

Enclosing class:

DiffRequest

public static class DiffRequest.Builder
extends AbstractDiffRequest.AbstractBuilder<DiffRequest.Builder,DiffRequest>

Field Summary

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

NOT_BLANK

Constructor Summary

Constructors

Constructor and Description
Builder(DiffRequest request)
Builder(Repository repository, String untilId)

Method Summary

Modifier and Type	Method and Description
DiffRequest.Builder	autoSrcPath(boolean value)
DiffRequest	build()
DiffRequest.Builder	contextLines(int value) Specifies the number of context lines to include around added/removed lines.
DiffRequest.Builder	path(String value)
DiffRequest.Builder	paths(Iterable<String> values)
DiffRequest.Builder	paths(String value, String... values)
DiffRequest.Builder	secondaryRepository(Repository value)
protected DiffRequest.Builder	self()
DiffRequest.Builder	sinceId(String value) Specifies the "since" commit for the diff.
DiffRequest.Builder	whitespace(DiffWhitespace value)
DiffRequest.Builder	withComments(boolean value) Whether to include comments associated to the diff in the response to the request

Methods inherited from class com.atlassian.bitbucket.content.AbstractDiffRequest.AbstractBuilder

filter

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
               DiffRequest request)

Builder

public Builder(@Nonnull
               Repository repository,
               @Nonnull
               String untilId)

Method Detail

autoSrcPath

@Nonnull
public DiffRequest.Builder autoSrcPath(boolean value)

build

@Nonnull
public DiffRequest build()

Specified by:

build in class AbstractDiffRequest.AbstractBuilder<DiffRequest.Builder,DiffRequest>

contextLines

@Nonnull
public DiffRequest.Builder contextLines(int value)

Description copied from class: AbstractDiffRequest.AbstractBuilder

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 AbstractDiffRequest.DEFAULT_CONTEXT_LINES for clarity: contextLines(DiffRequest.DEFAULT_CONTEXT_LINES).

Overrides:

contextLines in class AbstractDiffRequest.AbstractBuilder<DiffRequest.Builder,DiffRequest>

Parameters:

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

Returns:

this

secondaryRepository

@Nonnull
public DiffRequest.Builder secondaryRepository(@Nullable
                                                        Repository value)

Parameters:

value - the secondary repository from which to generate the diff

Returns:

this

Since:

6.7

sinceId

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

Specifies the "since" commit for the diff. Generally this is an ancestor of the "until" commit, but it is not required to be.

If the "since" and "until" commit are not directly related, the returned diff may not make sense. For example, it may show files as added, removed or modified that have not actually been changed. When an explicit "since" commit is provided, it is recommended to always use an ancestor of the "until" commit.

Parameters:

value - the "since" commit's ID, which will be trimmed to null if blank

Returns:

this

path

@Nonnull
public DiffRequest.Builder path(@Nullable
                                         String value)

Overrides:

path in class AbstractDiffRequest.AbstractBuilder<DiffRequest.Builder,DiffRequest>

paths

@Nonnull
public DiffRequest.Builder paths(@Nullable
                                          Iterable<String> values)

Overrides:

paths in class AbstractDiffRequest.AbstractBuilder<DiffRequest.Builder,DiffRequest>

paths

@Nonnull
public DiffRequest.Builder paths(@Nullable
                                          String value,
                                          @Nullable
                                          String... values)

Overrides:

paths in class AbstractDiffRequest.AbstractBuilder<DiffRequest.Builder,DiffRequest>

whitespace

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

Overrides:

whitespace in class AbstractDiffRequest.AbstractBuilder<DiffRequest.Builder,DiffRequest>

withComments

@Nonnull
public DiffRequest.Builder withComments(boolean value)

Whether to include comments associated to the diff in the response to the request

Parameters:

value - true if the comments should be included. false otherwise.

Returns:

this builder

self

@Nonnull
protected DiffRequest.Builder self()

Specified by:

self in class AbstractDiffRequest.AbstractBuilder<DiffRequest.Builder,DiffRequest>