com.atlassian.bitbucket.comment

Interface Comment

All Superinterfaces:

PropertySupport, TaskAnchor

public interface Comment
extends PropertySupport, TaskAnchor

A comment on a pull request or commit.

Method Summary

Modifier and Type	Method and Description
Optional<CommentThreadDiffAnchor>	getAnchor() This is a short-hand for comment.getThread().getAnchor()
ApplicationUser	getAuthor()
List<Comment>	getComments()
Date	getCreatedDate()
long	getId()
Optional<CommentOperations>	getPermittedOperations()
Date	getResolvedDate()
ApplicationUser	getResolver() Retrieves the user who resolved the comment.
CommentSeverity	getSeverity()
CommentState	getState()
List<Task>	getTasks() Deprecated. in 7.0 for removal in 8.0. Use getComments() instead; CommentSeverity.BLOCKER comments are treated as tasks.
String	getText()
CommentThread	getThread()
Date	getUpdatedDate()
int	getVersion()

Methods inherited from interface com.atlassian.bitbucket.property.PropertySupport

getProperties

Methods inherited from interface com.atlassian.bitbucket.task.TaskAnchor

accept

Method Detail

getAnchor

@Nonnull
Optional<CommentThreadDiffAnchor> getAnchor()

This is a short-hand for comment.getThread().getAnchor()

Returns:

the anchor associated with this comment's thread

Since:

5.0

getAuthor

@Nonnull
ApplicationUser getAuthor()

Returns:

the author of the comment

getComments

@Nonnull
List<Comment> getComments()

Returns:

the direct replies to the comment, or an empty list of there are none

getCreatedDate

@Nonnull
Date getCreatedDate()

Returns:

the date when the comment was originally created

See Also:

getUpdatedDate()

getId

long getId()

Specified by:

getId in interface TaskAnchor

Returns:

the comment's ID, which is globally unique

getPermittedOperations

@Nonnull
Optional<CommentOperations> getPermittedOperations()

Returns:

the operations allowed by the current user. If not present then none are permitted

Since:

5.0

getResolvedDate

@Nullable
Date getResolvedDate()

Returns:

the date that the comment was resolved or null if not resolved.

Since:

6.7

getResolver

@Nullable
ApplicationUser getResolver()

Retrieves the user who resolved the comment.

Returns:

the user who resolved the comment or null if not resolved

Since:

6.7

getSeverity

@Nonnull
CommentSeverity getSeverity()

Returns:

the severity for this comment

Since:

6.7

getState

@Nonnull
CommentState getState()

Returns:

the state for this comment

Since:

6.7

getTasks

@Deprecated
 @Nonnull
List<Task> getTasks()

Deprecated. in 7.0 for removal in 8.0. Use getComments() instead; CommentSeverity.BLOCKER comments are treated as tasks.

Returns:

the tasks attached to this comment, or an empty list if there are none

getText

@Nonnull
 @RequiredString(size=32768)
String getText()

Returns:

the raw text of the comment (limited to 32k)

getThread

@Nonnull
CommentThread getThread()

Returns:

the thread this comment is a part of

Since:

5.0

getUpdatedDate

@Nonnull
Date getUpdatedDate()

Returns:

the date of the last update

See Also:

getCreatedDate()

getVersion

int getVersion()

Returns:

the current version of the comment

See Also:

getUpdatedDate()