com.google.gerrit.server.notedb

Class ChangeUpdate

java.lang.Object

com.google.gerrit.server.git.VersionedMetaData

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

Nested classes/interfaces inherited from class com.google.gerrit.server.git.VersionedMetaData

VersionedMetaData.BatchMetaDataUpdate

Field Summary

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

anonymousCowardName, ctl, migration, psId, repoManager, serverIdent, updateFactory, when

Fields inherited from class com.google.gerrit.server.git.VersionedMetaData

inserter, newTree, reader

Method Summary

Modifier and Type	Method and Description
org.eclipse.jgit.revwalk.RevCommit	commit()
void	deleteComment(com.google.gerrit.reviewdb.client.PatchLineComment comment)
protected com.google.gerrit.reviewdb.client.Project.NameKey	getProjectName()
protected java.lang.String	getRefName()
void	insertComment(com.google.gerrit.reviewdb.client.PatchLineComment comment)
protected boolean	onSave(org.eclipse.jgit.lib.CommitBuilder commit) Save any changes to the metadata in a commit.
void	putApproval(java.lang.String label, short value)
void	putReviewer(com.google.gerrit.reviewdb.client.Account.Id reviewer, ReviewerState type)
void	removeApproval(java.lang.String label)
void	removeReviewer(com.google.gerrit.reviewdb.client.Account.Id reviewer)
void	setChangeMessage(java.lang.String changeMessage)
void	setHashtags(java.util.Set<java.lang.String> hashtags)
void	setStatus(com.google.gerrit.reviewdb.client.Change.Status status)
void	setSubject(java.lang.String subject)
void	submit(java.lang.Iterable<com.google.gerrit.common.data.SubmitRecord> submitRecords)
void	updateComment(com.google.gerrit.reviewdb.client.PatchLineComment comment)
void	upsertComment(com.google.gerrit.reviewdb.client.PatchLineComment comment)
void	writeCommit(VersionedMetaData.BatchMetaDataUpdate batch) Writes commit to a BatchMetaDataUpdate without committing the batch.

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

commit, getChange, getChangeNotes, getPatchSetId, getUser, getWhen, newIdent, onLoad, openUpdate, openUpdate, openUpdateInBatch, setInserter, setPatchSetId

Methods inherited from class com.google.gerrit.server.git.VersionedMetaData

commitToNewRef, getObjectId, getRevision, load, load, load, load, readConfig, readFile, readTree, readUTF8, saveConfig, saveFile, saveUTF8, set, set, set

Methods inherited from class java.lang.Object

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

Method Detail

setStatus

public void setStatus(com.google.gerrit.reviewdb.client.Change.Status status)

putApproval

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

removeApproval

public void removeApproval(java.lang.String label)

submit

public void submit(java.lang.Iterable<com.google.gerrit.common.data.SubmitRecord> submitRecords)

setSubject

public void setSubject(java.lang.String subject)

setChangeMessage

public void setChangeMessage(java.lang.String changeMessage)

insertComment

public void insertComment(com.google.gerrit.reviewdb.client.PatchLineComment comment)
                   throws com.google.gwtorm.server.OrmException

Throws:

com.google.gwtorm.server.OrmException

upsertComment

public void upsertComment(com.google.gerrit.reviewdb.client.PatchLineComment comment)
                   throws com.google.gwtorm.server.OrmException

Throws:

com.google.gwtorm.server.OrmException

updateComment

public void updateComment(com.google.gerrit.reviewdb.client.PatchLineComment comment)
                   throws com.google.gwtorm.server.OrmException

Throws:

com.google.gwtorm.server.OrmException

deleteComment

public void deleteComment(com.google.gerrit.reviewdb.client.PatchLineComment comment)
                   throws com.google.gwtorm.server.OrmException

Throws:

com.google.gwtorm.server.OrmException

setHashtags

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

putReviewer

public void putReviewer(com.google.gerrit.reviewdb.client.Account.Id reviewer,
                        ReviewerState type)

removeReviewer

public void removeReviewer(com.google.gerrit.reviewdb.client.Account.Id reviewer)

commit

public org.eclipse.jgit.revwalk.RevCommit commit()
                                          throws java.io.IOException

Throws:

java.io.IOException

writeCommit

public void writeCommit(VersionedMetaData.BatchMetaDataUpdate batch)
                 throws com.google.gwtorm.server.OrmException,
                        java.io.IOException

Description copied from class: AbstractChangeUpdate

Writes commit to a BatchMetaDataUpdate without committing the batch.

Specified by:

writeCommit in class AbstractChangeUpdate

Throws:

com.google.gwtorm.server.OrmException

java.io.IOException

getRefName

protected java.lang.String getRefName()

Specified by:

getRefName in class VersionedMetaData

Returns:

name of the reference storing this configuration.

onSave

protected boolean onSave(org.eclipse.jgit.lib.CommitBuilder commit)

Description copied from class: VersionedMetaData

Save any changes to the metadata in a commit.

Specified by:

onSave in class VersionedMetaData

Returns:

true if the commit should proceed, false to abort.

getProjectName

protected com.google.gerrit.reviewdb.client.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.