public class

AddFileCommentRequest

extends AddCommentRequest
java.lang.Object
   ↳ com.atlassian.bitbucket.comment.AddCommentRequest
     ↳ com.atlassian.bitbucket.comment.AddFileCommentRequest
Known Direct Subclasses

Class Overview

Request to create or update a file comment.

Summary

Nested Classes
class AddFileCommentRequest.AbstractFileBuilder<B extends AbstractFileBuilder<B, R extends AddFileCommentRequest>, R>  
class AddFileCommentRequest.Builder  
Protected Constructors
AddFileCommentRequest(AbstractFileBuilder builder)
Public Methods
@Nonnull CommentThreadDiffAnchorType getDiffType()
@Nullable String getFromHash()
@Nonnull String getPath()
@Nullable String getSrcPath()
@Nullable String getToHash()
[Expand]
Inherited Methods
From class com.atlassian.bitbucket.comment.AddCommentRequest
From class java.lang.Object

Protected Constructors

protected AddFileCommentRequest (AbstractFileBuilder builder)

Public Methods

@Nonnull public CommentThreadDiffAnchorType getDiffType ()

Returns
  • the type of diff the comment is being added on

@Nullable public String getFromHash ()

Returns
  • the fromHash for the diff onto which the comment is to be anchored. A null value will prompt the system to try and resolve the most suitable fromHash which can be null for comments made on a commit which doesn't have a parent (i.e.: initial commits).

@Nonnull public String getPath ()

Returns
  • the path to the file on which the comment is to be added

@Nullable public String getSrcPath ()

Returns
  • the path the file on which the comment is to be added used to have

@Nullable public String getToHash ()

Returns
  • the toHash for the diff onto which the comment is to be anchored.