com.atlassian.crucible.spi.data
Class VersionedLineCommentData

java.lang.Object
  com.atlassian.crucible.spi.data.CommentDataImpl
      com.atlassian.crucible.spi.data.VersionedCommentData
          com.atlassian.crucible.spi.data.VersionedLineCommentData

All Implemented Interfaces:

CommentData, java.io.Serializable

public class VersionedLineCommentData
extends VersionedCommentData
implements java.io.Serializable

Contains the attributes of a comment on an item in a review. If the line ranges are null, then the comment referes to the entire file

See Also:

Serialized Form

Nested Class Summary

static class

VersionedLineCommentData.LineRangeDetail

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

CommentData.Status

Field Summary

Fields inherited from class com.atlassian.crucible.spi.data.VersionedCommentData

reviewItemId

Constructor Summary

VersionedLineCommentData()

VersionedLineCommentData(PermId<ReviewItemData> reviewItemId, java.lang.String message, boolean draft, boolean deleted, boolean defectRaised, boolean defectApproved, CommentData.Status readStatus, UserData user, java.util.Date createDate, java.lang.String fromLineRange, java.lang.String toLineRange, java.util.List<GeneralCommentData> replies, java.util.Map<java.lang.String,CustomFieldData> metrics, java.lang.String parentPermId)

VersionedLineCommentData(PermId<ReviewItemData> reviewItemId, java.lang.String message, boolean draft, boolean deleted, boolean defectRaised, boolean defectApproved, CommentData.Status readStatus, UserData user, java.util.Date createDate, java.lang.String fromLineRange, java.lang.String toLineRange, java.lang.String permId, java.util.List<GeneralCommentData> replies, java.util.Map<java.lang.String,CustomFieldData> metrics, java.lang.String parentPermId)

Method Summary

java.lang.String	getFromLineRange() Deprecated. returns the line range on the oldest revision only (pre-iterative reviewing). Use getLineRanges() instead.
java.util.List<VersionedLineCommentData.LineRangeDetail>	getLineRanges()
java.lang.String	getToLineRange() Deprecated. returns the line range on the newest revision only (pre-iterative reviewing). Use getLineRanges() instead.
void	setFromLineRange(java.lang.String fromLineRange) Deprecated. use setLineRanges(java.util.List) instead.
void	setLineRanges(java.util.List<VersionedLineCommentData.LineRangeDetail> details)
void	setToLineRange(java.lang.String toLineRange) Deprecated. use setLineRanges(java.util.List) instead.

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

getPermaId, getReviewItemId, setPermaId, setReviewItemId

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

getCreateDate, getMessage, getMetrics, getParentCommentId, getPermaIdAsString, getReadStatus, getReplies, getUser, isDefectApproved, isDefectRaised, isDeleted, isDraft, setCreateDate, setDefectApproved, setDefectRaised, setDeleted, setDraft, setMessage, 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

VersionedLineCommentData

public VersionedLineCommentData()

VersionedLineCommentData

public VersionedLineCommentData(PermId<ReviewItemData> reviewItemId,
                                java.lang.String message,
                                boolean draft,
                                boolean deleted,
                                boolean defectRaised,
                                boolean defectApproved,
                                CommentData.Status readStatus,
                                UserData user,
                                java.util.Date createDate,
                                java.lang.String fromLineRange,
                                java.lang.String toLineRange,
                                java.util.List<GeneralCommentData> replies,
                                java.util.Map<java.lang.String,CustomFieldData> metrics,
                                java.lang.String parentPermId)

VersionedLineCommentData

public VersionedLineCommentData(PermId<ReviewItemData> reviewItemId,
                                java.lang.String message,
                                boolean draft,
                                boolean deleted,
                                boolean defectRaised,
                                boolean defectApproved,
                                CommentData.Status readStatus,
                                UserData user,
                                java.util.Date createDate,
                                java.lang.String fromLineRange,
                                java.lang.String toLineRange,
                                java.lang.String permId,
                                java.util.List<GeneralCommentData> replies,
                                java.util.Map<java.lang.String,CustomFieldData> metrics,
                                java.lang.String parentPermId)

Method Detail

getFromLineRange

public java.lang.String getFromLineRange()

Deprecated. returns the line range on the oldest revision only (pre-iterative reviewing). Use getLineRanges() instead.

Returns the line range on the oldest revision in of the review item. Note that this field predates support for iterative reviews. This method will NOT return a value if the comment was made on revisions other than the oldest.

Returns:

the line range on the oldest revision.

getToLineRange

public java.lang.String getToLineRange()

Deprecated. returns the line range on the newest revision only (pre-iterative reviewing). Use getLineRanges() instead.

Returns the line range on the newest revision in of the review item. Note that this field predates support for iterative reviews. This method will NOT return a value if the comment was made on revisions other than the newest.

Returns:

the line range on the newest revision in of the review item.

setFromLineRange

public void setFromLineRange(java.lang.String fromLineRange)

Deprecated. use setLineRanges(java.util.List) instead.

Parameters:

fromLineRange -

setToLineRange

public void setToLineRange(java.lang.String toLineRange)

Deprecated. use setLineRanges(java.util.List) instead.

Parameters:

toLineRange -

getLineRanges

public java.util.List<VersionedLineCommentData.LineRangeDetail> getLineRanges()

Returns:

the line ranges on all file revisions.

setLineRanges

public void setLineRanges(java.util.List<VersionedLineCommentData.LineRangeDetail> details)

Parameters:

details - the line ranges on all file revisions.