Package com.atlassian.bitbucket.pull

Class PullRequestDiffRequest

java.lang.Object
com.atlassian.bitbucket.pull.AbstractPullRequestRequest
com.atlassian.bitbucket.pull.PullRequestDiffRequest
public class PullRequestDiffRequest extends AbstractPullRequestRequest
Request for streaming a diff of a given pull request. The purpose and behaviour of each field is described on its accessor.

  • Field Details

    • DEFAULT_CONTEXT_LINES

      public static final int DEFAULT_CONTEXT_LINES
      Indicates the request should supply the default number of context lines for added and removed lines. The default is configurable, so it may be changed by a system administrator. The shipped setting is 10 lines.
      See Also:

  • Method Details

    • getContextLines

      public int getContextLines()
      Retrieves the numbers of context lines to show around added and removed lines. If the value is 0 context will be omitted and only added and removed lines will be shown. For positive values, that number of lines will be shown. For negative values, the system-configured default number will be shown.
      Returns:
      the number of context lines that should be included around added and removed lines in the diff

    • getDiffType

      @Nullable public CommentThreadDiffAnchorType getDiffType()
      Returns:
      the type of diff requested
      Since:
      5.0

    • getFilter

      @Nullable public DiffContentFilter getFilter()
      Returns:
      an optional filter for this diff to filter out lines (and their surrounding file/hunk/segment)

    • getPath

      @Nullable public String getPath()
      Returns:
      the path within the repository to the file to diff

    • getSinceId

      @Nullable public String getSinceId()
      Returns:
      the sinceId for the diff requested
      Since:
      5.0

    • getSrcPath

      @Nullable public String getSrcPath()
      Returns:
      the source path, required for copies and moves/renames and null for other types

    • getUntilId

      @Nullable public String getUntilId()
      Returns:
      the untilId for the diff requested
      Since:
      5.0

    • getWhitespace

      @Nonnull public DiffWhitespace getWhitespace()
      Returns:
      the whitespace settings used in the diff

    • hasContextLines

      public boolean hasContextLines()
      Retrieves a flag indicating whether an explicit number of context lines has been requested. When this method returns true, getContextLines() will return a value greater than or equal to 0, When it returns false, getContextLines() will return DEFAULT_CONTEXT_LINES.
      Returns:
      true if a non-default number of context lines has been requested; otherwise, false to use the default number of lines

    • isWithComments

      public boolean isWithComments()