@PublicApi public interface

MutableComment

implements Comment
com.atlassian.jira.issue.comments.MutableComment
Known Indirect Subclasses

@PublicApi

This interface is designed for plugins to consume (call its methods).

Clients of @PublicApi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicApi as per each product's API policy as long as the client does not implement/extend @PublicApi interfaces or classes (refer to each product's API policy for the exact guarantee---usually binary compatibility is guaranteed at least across minor versions).

Note: since @PublicApi interfaces and classes are not designed to be implemented or extended by clients, we may perform certain types of binary-incompatible changes to these classes and interfaces, but these will not affect well-behaved clients that do not extend/implement these types (in general, only classes and interfaces annotated with @PublicSpi are safe to extend/implement).

Class Overview

Represents a comment's in JIRA. After calling any 'setter' method, you will need to call update(User, MutableComment, boolean, ErrorCollection) which does permission checking or update(Comment, boolean) which will just store the provided object, to persist the change to the database.

Summary

Public Methods
void setAuthor(ApplicationUser author)
void setAuthor(String author)
This method is deprecated. Use setAuthor(com.atlassian.jira.user.ApplicationUser) instead. Since v6.0.
void setBody(String body)
void setCreated(Date created)
void setGroupLevel(String groupLevel)
void setRoleLevelId(Long roleLevelId)
void setUpdateAuthor(ApplicationUser updateAuthor)
void setUpdateAuthor(String updateAuthor)
This method is deprecated. Use setUpdateAuthor(com.atlassian.jira.user.ApplicationUser) instead. Since v6.0.
void setUpdated(Date updated)
[Expand]
Inherited Methods
From interface com.atlassian.jira.entity.WithId
From interface com.atlassian.jira.issue.comments.Comment

Public Methods

public void setAuthor (ApplicationUser author)

Parameters
author ApplicationUser to be set as author.

public void setAuthor (String author)

This method is deprecated.
Use setAuthor(com.atlassian.jira.user.ApplicationUser) instead. Since v6.0.

Parameters
author userkey of the user to be set as author.

public void setBody (String body)

public void setCreated (Date created)

public void setGroupLevel (String groupLevel)

public void setRoleLevelId (Long roleLevelId)

public void setUpdateAuthor (ApplicationUser updateAuthor)

Parameters
updateAuthor ApplicationUser to be set as update author (i.e. the comment editor).

public void setUpdateAuthor (String updateAuthor)

This method is deprecated.
Use setUpdateAuthor(com.atlassian.jira.user.ApplicationUser) instead. Since v6.0.

Parameters
updateAuthor userkey of the user to be set as update author (i.e. the comment editor).

public void setUpdated (Date updated)