public class

DiffRequest

extends AbstractDiffRequest
java.lang.Object
   ↳ com.atlassian.bitbucket.content.AbstractDiffRequest
     ↳ com.atlassian.bitbucket.content.DiffRequest

Class Overview

Request arguments for streamDiff(DiffRequest, DiffContentCallback).

Summary

Nested Classes
class DiffRequest.Builder  
[Expand]
Inherited Constants
From class com.atlassian.bitbucket.content.AbstractDiffRequest
Public Methods
Long getPullRequestId()
When comments should be returned as well (isWithComments() == true), a pull request ID can be provided to only retrieve comments that were made in the context of that pull request.
@Nonnull Repository getRepository()
@Nullable String getSinceId()
@Nonnull String getUntilId()
boolean isWithAutoSrcPath()
boolean isWithComments()
[Expand]
Inherited Methods
From class com.atlassian.bitbucket.content.AbstractDiffRequest
From class java.lang.Object

Public Methods

public Long getPullRequestId ()

When comments should be returned as well (isWithComments() == true), a pull request ID can be provided to only retrieve comments that were made in the context of that pull request. If no pull request ID is provided, only comments made outside the context of any pull request will be retrieved.

Returns
  • the ID for the pull request in which the diff will be displayed

@Nonnull public Repository getRepository ()

Returns
  • the repository to use

@Nullable public String getSinceId ()

Returns
  • the "since" commit for the diff or null for the untilId's parent

@Nonnull public String getUntilId ()

Returns
  • the "until" commit for the diff

public boolean isWithAutoSrcPath ()

Returns
  • true if attempting to resolve the source path in case of a rename, false otherise. Only valid for a single path.

public boolean isWithComments ()

Returns
  • true if the comment associated with the diff should be included in the response to this request. false otherwise