Package com.atlassian.bitbucket.comment

Class AddFileCommentRequest

java.lang.Object

com.atlassian.bitbucket.comment.AddCommentRequest

com.atlassian.bitbucket.comment.AddFileCommentRequest

Direct Known Subclasses:

AddLineCommentRequest

public class AddFileCommentRequest
extends AddCommentRequest

Request to create or update a file comment.

Since:

5.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	AddFileCommentRequest.AbstractFileBuilder<B extends AddFileCommentRequest.AbstractFileBuilder<B,R>,R extends AddFileCommentRequest>
static class	AddFileCommentRequest.Builder

Nested classes/interfaces inherited from class com.atlassian.bitbucket.comment.AddCommentRequest

AddCommentRequest.AbstractBuilder<B extends AddCommentRequest.AbstractBuilder<B,R>,R extends AddCommentRequest>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AddFileCommentRequest(AddFileCommentRequest.AbstractFileBuilder builder)

Method Summary

Modifier and Type	Method	Description
CommentThreadDiffAnchorType	getDiffType()
String	getFromHash()	Retrieve the fromHash for the diff onto which the comment is to be anchored.
String	getPath()
String	getSrcPath()
String	getToHash()

Methods inherited from class com.atlassian.bitbucket.comment.AddCommentRequest

getCommentable, getSeverity, getText, isPending

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AddFileCommentRequest

protected AddFileCommentRequest(@Nonnull
 AddFileCommentRequest.AbstractFileBuilder builder)

Method Details

getDiffType

@Nonnull
public CommentThreadDiffAnchorType getDiffType()

Returns:

the type of diff the comment is being added on

getFromHash

@Nullable
public String getFromHash()

Retrieve the fromHash for the diff onto which the comment is to be anchored.

If this value is null and the AddCommentRequest.getCommentable() is a CommitDiscussion the system will try to resolve the most suitable fromHash. This could be null for commits which do not have a parent (e.g. initial commit).

For other AddCommentRequest.getCommentable() types, if the getDiffType() is CommentThreadDiffAnchorType.COMMIT or CommentThreadDiffAnchorType.RANGE, the fromHash must be included on the request.

Returns:

the fromHash for the diff anchor

getPath

@Nonnull
public String getPath()

Returns:

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

getSrcPath

@Nullable
public String getSrcPath()

Returns:

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

getToHash

@Nullable
public String getToHash()

Returns:

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