com.google.gerrit.server.notedb

Class ChangeUpdate

java.lang.Object

com.google.gerrit.server.notedb.AbstractChangeUpdate

com.google.gerrit.server.notedb.ChangeUpdate

public class ChangeUpdate
extends AbstractChangeUpdate

A delta to apply to a change.

This delta will become two unique commits: one in the AllUsers repo that will contain the draft comments on this change and one in the notes branch that will contain approvals, reviewers, change status, subject, submit records, the change message, and published comments. There are limitations on the set of modifications that can be handled in a single update. In particular, there is a single author and timestamp for each update.

This class is not thread-safe.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ChangeUpdate.Factory

Field Summary

Fields inherited from class com.google.gerrit.server.notedb.AbstractChangeUpdate

accountId, authorIdent, NO_OP_UPDATE, noteUtil, psId, realAccountId, rootOnly, serverIdent, when

Method Summary

Modifier and Type	Method and Description
boolean	allowWriteToNewRef()
protected org.eclipse.jgit.lib.CommitBuilder	applyImpl(org.eclipse.jgit.revwalk.RevWalk rw, org.eclipse.jgit.lib.ObjectInserter ins, org.eclipse.jgit.lib.ObjectId curr) Create a commit containing the contents of this update.
org.eclipse.jgit.lib.ObjectId	commit()
void	deleteChangeMessageByRewritingHistory(java.lang.String targetMessageId, java.lang.String newMessage)
void	deleteComment(Comment c)
void	deleteCommentByRewritingHistory(java.lang.String uuid, java.lang.String newMessage)
void	fixStatus(Change.Status status)
DeleteChangeMessageRewriter	getDeleteChangeMessageRewriter()
DeleteCommentRewriter	getDeleteCommentRewriter()
protected Project.NameKey	getProjectName()
protected java.lang.String	getRefName()
java.util.Map<Account.Id,ReviewerStateInternal>	getReviewers()
boolean	isEmpty() Whether no updates have been done.
void	merge(com.google.gerrit.server.logging.RequestId submissionId, java.lang.Iterable<SubmitRecord> submitRecords)
void	putApproval(java.lang.String label, short value)
void	putApprovalFor(Account.Id reviewer, java.lang.String label, short value)
void	putComment(PatchLineComment.Status status, Comment c)
void	putReviewer(Account.Id reviewer, ReviewerStateInternal type)
void	putReviewerByEmail(com.google.gerrit.mail.Address reviewer, ReviewerStateInternal type)
void	putRobotComment(RobotComment c)
void	removeApproval(java.lang.String label)
void	removeApprovalFor(Account.Id reviewer, java.lang.String label)
void	removeAssignee()
void	removeReviewer(Account.Id reviewer)
void	removeReviewerByEmail(com.google.gerrit.mail.Address reviewer)
void	setAllowWriteToNewRef(boolean allow)
void	setAssignee(Account.Id assignee)
void	setBranch(java.lang.String branch)
void	setChangeId(java.lang.String changeId)
void	setChangeMessage(java.lang.String changeMessage)
void	setCommit(org.eclipse.jgit.revwalk.RevWalk rw, org.eclipse.jgit.lib.ObjectId id)
void	setCommit(org.eclipse.jgit.revwalk.RevWalk rw, org.eclipse.jgit.lib.ObjectId id, java.lang.String pushCert)
void	setCurrentPatchSet()
void	setGroups(java.util.List<java.lang.String> groups)
void	setHashtags(java.util.Set<java.lang.String> hashtags)
void	setPatchSetState(PatchSetState psState)
void	setPrivate(boolean isPrivate)
void	setPsDescription(java.lang.String psDescription)
void	setRevertOf(int revertOf)
void	setRevisionForMissingCommit(java.lang.String id, java.lang.String pushCert) Set the revision without depending on the commit being present in the repository; should only be used for converting old corrupt commits.
void	setStatus(Change.Status status)
void	setSubject(java.lang.String subject)
void	setSubjectForCommit(java.lang.String commitSubject)
void	setSubmissionId(java.lang.String submissionId) Deprecated.
void	setTag(java.lang.String tag)
void	setTopic(java.lang.String topic)
void	setWorkInProgress(boolean workInProgress)

Methods inherited from class com.google.gerrit.server.notedb.AbstractChangeUpdate

getAccountId, getChange, getId, getNotes, getNullableAccountId, getPatchSetId, getWhen, isRootOnly, newIdent, setParentCommit, setPatchSetId, verifyComment

Methods inherited from class java.lang.Object

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

Method Detail

commit

public org.eclipse.jgit.lib.ObjectId commit()
                                     throws java.io.IOException

Throws:

java.io.IOException

setChangeId

public void setChangeId(java.lang.String changeId)

setBranch

public void setBranch(java.lang.String branch)

setStatus

public void setStatus(Change.Status status)

fixStatus

public void fixStatus(Change.Status status)

putApproval

public void putApproval(java.lang.String label,
                        short value)

putApprovalFor

public void putApprovalFor(Account.Id reviewer,
                           java.lang.String label,
                           short value)

removeApproval

public void removeApproval(java.lang.String label)

removeApprovalFor

public void removeApprovalFor(Account.Id reviewer,
                              java.lang.String label)

merge

public void merge(com.google.gerrit.server.logging.RequestId submissionId,
                  java.lang.Iterable<SubmitRecord> submitRecords)

setSubmissionId

@Deprecated
public void setSubmissionId(java.lang.String submissionId)

Deprecated.

setSubjectForCommit

public void setSubjectForCommit(java.lang.String commitSubject)

setSubject

public void setSubject(java.lang.String subject)

setChangeMessage

public void setChangeMessage(java.lang.String changeMessage)

setTag

public void setTag(java.lang.String tag)

setPsDescription

public void setPsDescription(java.lang.String psDescription)

putComment

public void putComment(PatchLineComment.Status status,
                       Comment c)

putRobotComment

public void putRobotComment(RobotComment c)

deleteComment

public void deleteComment(Comment c)

deleteCommentByRewritingHistory

public void deleteCommentByRewritingHistory(java.lang.String uuid,
                                            java.lang.String newMessage)

deleteChangeMessageByRewritingHistory

public void deleteChangeMessageByRewritingHistory(java.lang.String targetMessageId,
                                                  java.lang.String newMessage)

setTopic

public void setTopic(java.lang.String topic)

setCommit

public void setCommit(org.eclipse.jgit.revwalk.RevWalk rw,
                      org.eclipse.jgit.lib.ObjectId id)
               throws java.io.IOException

Throws:

java.io.IOException

setCommit

public void setCommit(org.eclipse.jgit.revwalk.RevWalk rw,
                      org.eclipse.jgit.lib.ObjectId id,
                      java.lang.String pushCert)
               throws java.io.IOException

Throws:

java.io.IOException

setRevisionForMissingCommit

public void setRevisionForMissingCommit(java.lang.String id,
                                        java.lang.String pushCert)

Set the revision without depending on the commit being present in the repository; should only be used for converting old corrupt commits.

setHashtags

public void setHashtags(java.util.Set<java.lang.String> hashtags)

setAssignee

public void setAssignee(Account.Id assignee)

removeAssignee

public void removeAssignee()

getReviewers

public java.util.Map<Account.Id,ReviewerStateInternal> getReviewers()

putReviewer

public void putReviewer(Account.Id reviewer,
                        ReviewerStateInternal type)

removeReviewer

public void removeReviewer(Account.Id reviewer)

putReviewerByEmail

public void putReviewerByEmail(com.google.gerrit.mail.Address reviewer,
                               ReviewerStateInternal type)

removeReviewerByEmail

public void removeReviewerByEmail(com.google.gerrit.mail.Address reviewer)

setPatchSetState

public void setPatchSetState(PatchSetState psState)

setCurrentPatchSet

public void setCurrentPatchSet()

setGroups

public void setGroups(java.util.List<java.lang.String> groups)

setRevertOf

public void setRevertOf(int revertOf)

getRefName

protected java.lang.String getRefName()

Specified by:

getRefName in class AbstractChangeUpdate

applyImpl

protected org.eclipse.jgit.lib.CommitBuilder applyImpl(org.eclipse.jgit.revwalk.RevWalk rw,
                                                       org.eclipse.jgit.lib.ObjectInserter ins,
                                                       org.eclipse.jgit.lib.ObjectId curr)
                                                throws java.io.IOException

Description copied from class: AbstractChangeUpdate

Create a commit containing the contents of this update.

Specified by:

applyImpl in class AbstractChangeUpdate

ins - inserter to write to; callers should not flush.

Returns:

a new commit builder representing this commit, or null to indicate the meta ref should be deleted as a result of this update. The parent, author, and committer fields in the return value are always overwritten. The tree ID may be unset by this method, which indicates to the caller that it should be copied from the parent commit. To indicate that this update is a no-op (but this could not be determined by AbstractChangeUpdate.isEmpty()), return the sentinel AbstractChangeUpdate.NO_OP_UPDATE.

Throws:

java.io.IOException - if a lower-level error occurred.

getProjectName

protected Project.NameKey getProjectName()

Specified by:

getProjectName in class AbstractChangeUpdate

Returns:

the NameKey for the project where the update will be stored, which is not necessarily the same as the change's project.

isEmpty

public boolean isEmpty()

Description copied from class: AbstractChangeUpdate

Whether no updates have been done.

Specified by:

isEmpty in class AbstractChangeUpdate

getDeleteCommentRewriter

public DeleteCommentRewriter getDeleteCommentRewriter()

getDeleteChangeMessageRewriter

public DeleteChangeMessageRewriter getDeleteChangeMessageRewriter()

setAllowWriteToNewRef

public void setAllowWriteToNewRef(boolean allow)

allowWriteToNewRef

public boolean allowWriteToNewRef()

Overrides:

allowWriteToNewRef in class AbstractChangeUpdate

setPrivate

public void setPrivate(boolean isPrivate)

setWorkInProgress

public void setWorkInProgress(boolean workInProgress)