com.google.gerrit.server

Class CommentsUtil

java.lang.Object

com.google.gerrit.server.CommentsUtil

public class CommentsUtil
extends java.lang.Object

Utility functions to manipulate Comments.

Field Summary

Fields

Modifier and Type	Field and Description
static com.google.common.collect.Ordering<CommentInfo>	COMMENT_INFO_ORDER
static com.google.common.collect.Ordering<Comment>	COMMENT_ORDER

Method Summary

Modifier and Type	Method and Description
java.util.List<Comment>	byPatchSet(ChangeNotes notes, PatchSet.Id psId)
void	deleteCommentByRewritingHistory(ChangeUpdate update, Comment.Key commentKey, java.lang.String newMessage)
void	deleteComments(ChangeUpdate update, java.lang.Iterable<Comment> comments)
java.util.List<Comment>	draftByChange(ChangeNotes notes)
java.util.List<Comment>	draftByChangeAuthor(ChangeNotes notes, Account.Id author)
java.util.List<Comment>	draftByChangeFileAuthor(ChangeNotes notes, java.lang.String file, Account.Id author)
java.util.List<Comment>	draftByPatchSetAuthor(PatchSet.Id psId, Account.Id author, ChangeNotes notes)
static java.lang.String	extractMessageId(java.lang.String tag)
static PatchSet.Id	getCommentPsId(Change.Id changeId, Comment comment)
java.util.Optional<Comment>	getDraft(ChangeNotes notes, IdentifiedUser user, Comment.Key key)
java.util.Collection<org.eclipse.jgit.lib.Ref>	getDraftRefs(Change.Id changeId) Get NoteDb draft refs for a change.
java.util.Optional<Comment>	getPublished(ChangeNotes notes, Comment.Key key)
Comment	newComment(ChangeContext ctx, java.lang.String path, PatchSet.Id psId, short side, java.lang.String message, java.lang.Boolean unresolved, java.lang.String parentUuid)
RobotComment	newRobotComment(ChangeContext ctx, java.lang.String path, PatchSet.Id psId, short side, java.lang.String message, java.lang.String robotId, java.lang.String robotRunId)
java.util.List<Comment>	publishedByChange(ChangeNotes notes)
java.util.List<Comment>	publishedByChangeFile(ChangeNotes notes, java.lang.String file)
java.util.List<Comment>	publishedByPatchSet(ChangeNotes notes, PatchSet.Id psId)
void	putComments(ChangeUpdate update, PatchLineComment.Status status, java.lang.Iterable<Comment> comments)
void	putRobotComments(ChangeUpdate update, java.lang.Iterable<RobotComment> comments)
java.util.List<RobotComment>	robotCommentsByChange(ChangeNotes notes)
java.util.List<RobotComment>	robotCommentsByPatchSet(ChangeNotes notes, PatchSet.Id psId)
static void	setCommentRevId(Comment c, PatchListCache cache, Change change, PatchSet ps)
static java.util.List<Comment>	toComments(java.lang.String serverId, java.lang.Iterable<PatchLineComment> comments)
static java.lang.Iterable<PatchLineComment>	toPatchLineComments(Change.Id changeId, PatchLineComment.Status status, java.lang.Iterable<Comment> comments)

Methods inherited from class java.lang.Object

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

Field Detail

COMMENT_ORDER

public static final com.google.common.collect.Ordering<Comment> COMMENT_ORDER

COMMENT_INFO_ORDER

public static final com.google.common.collect.Ordering<CommentInfo> COMMENT_INFO_ORDER

Method Detail

getCommentPsId

public static PatchSet.Id getCommentPsId(Change.Id changeId,
                                         Comment comment)

extractMessageId

public static java.lang.String extractMessageId(java.lang.String tag)

newComment

public Comment newComment(ChangeContext ctx,
                          java.lang.String path,
                          PatchSet.Id psId,
                          short side,
                          java.lang.String message,
                          java.lang.Boolean unresolved,
                          java.lang.String parentUuid)
                   throws UnprocessableEntityException

Throws:

UnprocessableEntityException

newRobotComment

public RobotComment newRobotComment(ChangeContext ctx,
                                    java.lang.String path,
                                    PatchSet.Id psId,
                                    short side,
                                    java.lang.String message,
                                    java.lang.String robotId,
                                    java.lang.String robotRunId)

getPublished

public java.util.Optional<Comment> getPublished(ChangeNotes notes,
                                                Comment.Key key)

getDraft

public java.util.Optional<Comment> getDraft(ChangeNotes notes,
                                            IdentifiedUser user,
                                            Comment.Key key)

publishedByChange

public java.util.List<Comment> publishedByChange(ChangeNotes notes)

robotCommentsByChange

public java.util.List<RobotComment> robotCommentsByChange(ChangeNotes notes)

draftByChange

public java.util.List<Comment> draftByChange(ChangeNotes notes)

byPatchSet

public java.util.List<Comment> byPatchSet(ChangeNotes notes,
                                          PatchSet.Id psId)

publishedByChangeFile

public java.util.List<Comment> publishedByChangeFile(ChangeNotes notes,
                                                     java.lang.String file)

publishedByPatchSet

public java.util.List<Comment> publishedByPatchSet(ChangeNotes notes,
                                                   PatchSet.Id psId)

robotCommentsByPatchSet

public java.util.List<RobotComment> robotCommentsByPatchSet(ChangeNotes notes,
                                                            PatchSet.Id psId)

draftByPatchSetAuthor

public java.util.List<Comment> draftByPatchSetAuthor(PatchSet.Id psId,
                                                     Account.Id author,
                                                     ChangeNotes notes)

draftByChangeFileAuthor

public java.util.List<Comment> draftByChangeFileAuthor(ChangeNotes notes,
                                                       java.lang.String file,
                                                       Account.Id author)

draftByChangeAuthor

public java.util.List<Comment> draftByChangeAuthor(ChangeNotes notes,
                                                   Account.Id author)

putComments

public void putComments(ChangeUpdate update,
                        PatchLineComment.Status status,
                        java.lang.Iterable<Comment> comments)

putRobotComments

public void putRobotComments(ChangeUpdate update,
                             java.lang.Iterable<RobotComment> comments)

deleteComments

public void deleteComments(ChangeUpdate update,
                           java.lang.Iterable<Comment> comments)

deleteCommentByRewritingHistory

public void deleteCommentByRewritingHistory(ChangeUpdate update,
                                            Comment.Key commentKey,
                                            java.lang.String newMessage)

setCommentRevId

public static void setCommentRevId(Comment c,
                                   PatchListCache cache,
                                   Change change,
                                   PatchSet ps)
                            throws PatchListNotAvailableException

Throws:

PatchListNotAvailableException

getDraftRefs

public java.util.Collection<org.eclipse.jgit.lib.Ref> getDraftRefs(Change.Id changeId)

Get NoteDb draft refs for a change.

Works if NoteDb is not enabled, but the results are not meaningful.

This is just a simple ref scan, so the results may potentially include refs for zombie draft comments. A zombie draft is one which has been published but the write to delete the draft ref from All-Users failed.

Parameters:

changeId - change ID.

Returns:

raw refs from All-Users repo.

toPatchLineComments

public static java.lang.Iterable<PatchLineComment> toPatchLineComments(Change.Id changeId,
                                                                       PatchLineComment.Status status,
                                                                       java.lang.Iterable<Comment> comments)

toComments

public static java.util.List<Comment> toComments(java.lang.String serverId,
                                                 java.lang.Iterable<PatchLineComment> comments)