com.atlassian.crucible.spi.data

Class GeneralCommentData

java.lang.Object

com.atlassian.crucible.spi.data.CommentDataImpl

com.atlassian.crucible.spi.data.GeneralCommentData

All Implemented Interfaces:

CommentData, java.io.Serializable

public class GeneralCommentData
extends CommentDataImpl
implements java.io.Serializable

Holds the attributes of a general comment on a Review

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GeneralCommentData.Builder Deprecated. Use GeneralCommentData.GeneralCommentBuilder instead.
static class	GeneralCommentData.GeneralCommentBuilder Call GeneralCommentData.GeneralCommentBuilder.build() to create an instance of GeneralCommentData.

Nested classes/interfaces inherited from class com.atlassian.crucible.spi.data.CommentDataImpl

CommentDataImpl.CommentDataBuilder<M extends CommentDataImpl.CommentDataBuilder,T extends CommentDataImpl>

Nested classes/interfaces inherited from interface com.atlassian.crucible.spi.data.CommentData

CommentData.Status

Constructor Summary

Constructors

Constructor and Description
GeneralCommentData() Deprecated. Use builder() instead.
GeneralCommentData(java.lang.String message, boolean draft, boolean deleted, boolean defectRaised, boolean defectApproved, CommentData.Status readStatus, UserData user, java.util.Date createDate, java.util.List<GeneralCommentData> replies, java.util.Map<java.lang.String,CustomFieldData> metrics, java.lang.String parentCommentPermId) Deprecated. Use builder() instead.
GeneralCommentData(java.lang.String message, boolean draft, boolean deleted, boolean defectRaised, boolean defectApproved, CommentData.Status readStatus, UserData user, java.util.Date createDate, java.lang.String permId, java.util.List<GeneralCommentData> replies, java.util.Map<java.lang.String,CustomFieldData> metrics, java.lang.String parentCommentPermId) Deprecated. Use builder() instead.
GeneralCommentData(java.lang.String message, java.lang.String messageHtml, boolean draft, boolean deleted, boolean defectRaised, boolean defectApproved, CommentData.Status readStatus, UserData user, java.util.Date createDate, java.util.List<GeneralCommentData> replies, java.util.Map<java.lang.String,CustomFieldData> metrics, java.lang.String parentCommentPermId) Deprecated. Use builder() instead.
GeneralCommentData(java.lang.String message, java.lang.String messageHtml, boolean draft, boolean deleted, boolean defectRaised, boolean defectApproved, CommentData.Status readStatus, UserData user, java.util.Date createDate, java.lang.String permId, java.util.List<GeneralCommentData> replies, java.util.Map<java.lang.String,CustomFieldData> metrics, java.lang.String parentCommentPermId) Deprecated. Use builder() instead.

Method Summary

Methods

Modifier and Type	Method and Description
static GeneralCommentData.GeneralCommentBuilder	builder()
static GeneralCommentData.Builder	create() Deprecated. Use builder() instead.
PermId<GeneralCommentData>	getPermaId() Get the comment's perma-id.
PermId<GeneralCommentData>	getPermId() Deprecated. Replaced by getPermaId().
void	setPermaId(PermId<GeneralCommentData> id) Set the comment's perma-id.
void	setPermId(PermId<GeneralCommentData> id) Deprecated. Replaced by setPermaId(com.atlassian.crucible.spi.PermId).

Methods inherited from class com.atlassian.crucible.spi.data.CommentDataImpl

getCreateDate, getMessage, getMessageAsHtml, getMetrics, getParentCommentId, getPermaIdAsString, getReadStatus, getReplies, getUser, isDefectApproved, isDefectRaised, isDeleted, isDraft, setCreateDate, setDefectApproved, setDefectRaised, setDeleted, setDraft, setMessage, setMessageAsHtml, setMetrics, setParentCommentId, setPermaIdAsString, setReadStatus, setReplies, setUser

Methods inherited from class java.lang.Object

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

Constructor Detail

GeneralCommentData

@Deprecated
public GeneralCommentData()

Deprecated. Use builder() instead.

for xml/json serialization only. Do not use.

GeneralCommentData

@Deprecated
public GeneralCommentData(java.lang.String message,
                             boolean draft,
                             boolean deleted,
                             boolean defectRaised,
                             boolean defectApproved,
                             CommentData.Status readStatus,
                             UserData user,
                             java.util.Date createDate,
                             java.util.List<GeneralCommentData> replies,
                             java.util.Map<java.lang.String,CustomFieldData> metrics,
                             java.lang.String parentCommentPermId)

Deprecated. Use builder() instead.

GeneralCommentData

@Deprecated
public GeneralCommentData(java.lang.String message,
                             boolean draft,
                             boolean deleted,
                             boolean defectRaised,
                             boolean defectApproved,
                             CommentData.Status readStatus,
                             UserData user,
                             java.util.Date createDate,
                             java.lang.String permId,
                             java.util.List<GeneralCommentData> replies,
                             java.util.Map<java.lang.String,CustomFieldData> metrics,
                             java.lang.String parentCommentPermId)

Deprecated. Use builder() instead.

GeneralCommentData

@Deprecated
public GeneralCommentData(java.lang.String message,
                             java.lang.String messageHtml,
                             boolean draft,
                             boolean deleted,
                             boolean defectRaised,
                             boolean defectApproved,
                             CommentData.Status readStatus,
                             UserData user,
                             java.util.Date createDate,
                             java.util.List<GeneralCommentData> replies,
                             java.util.Map<java.lang.String,CustomFieldData> metrics,
                             java.lang.String parentCommentPermId)

Deprecated. Use builder() instead.

Parameters:

message - the contents of the comment

messageHtml - the html representation of the comment. This can be null if creating a general comment, and is ignored by the ReviewService.addGeneralComment(com.atlassian.crucible.spi.PermId, GeneralCommentData)

GeneralCommentData

@Deprecated
public GeneralCommentData(java.lang.String message,
                             java.lang.String messageHtml,
                             boolean draft,
                             boolean deleted,
                             boolean defectRaised,
                             boolean defectApproved,
                             CommentData.Status readStatus,
                             UserData user,
                             java.util.Date createDate,
                             java.lang.String permId,
                             java.util.List<GeneralCommentData> replies,
                             java.util.Map<java.lang.String,CustomFieldData> metrics,
                             java.lang.String parentCommentPermId)

Deprecated. Use builder() instead.

Method Detail

create

@Deprecated
public static GeneralCommentData.Builder create()

Deprecated. Use builder() instead.

Returns:

a GeneralCommentData.Builder object that can be used to create an instance of this class.

getPermId

@Deprecated
public PermId<GeneralCommentData> getPermId()

Deprecated. Replaced by getPermaId().

setPermId

@Deprecated
public void setPermId(PermId<GeneralCommentData> id)

Deprecated. Replaced by setPermaId(com.atlassian.crucible.spi.PermId).

getPermaId

public PermId<GeneralCommentData> getPermaId()

Get the comment's perma-id.

setPermaId

public void setPermaId(PermId<GeneralCommentData> id)

Set the comment's perma-id.

This field should not be set by client code. Perma-ids are allocated when a comment is created.

builder

public static GeneralCommentData.GeneralCommentBuilder builder()

Returns:

a GeneralCommentData.GeneralCommentBuilder object which can be used to create an instance of GeneralCommentData.