ChangeUpdate (Gerrit Review Plugin API Documentation)

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 single delta to apply atomically to a change.
This delta becomes a single commit on the notes branch, so 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

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ChangeUpdate.Factory`

Field Summary
- Fields inherited from class com.google.gerrit.server.notedb.AbstractChangeUpdate
  ctl, migration, psId, repoManager, serverIdent, updateFactory, when
- Fields inherited from class com.google.gerrit.server.git.VersionedMetaData
  inserter, newTree, reader

Method Summary

Methods
Modifier and Type	Method and Description
`org.eclipse.jgit.revwalk.RevCommit`	`commit()`
`protected com.google.gerrit.reviewdb.client.Project.NameKey`	`getProjectName()`
`protected java.lang.String`	`getRefName()`
`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`	`putComment(com.google.gerrit.reviewdb.client.PatchLineComment comment)`
`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`	`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)`

Methods inherited from class com.google.gerrit.server.notedb.AbstractChangeUpdate
commit, getChange, getUser, getWhen, newIdent, onLoad, openUpdate, openUpdate, 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)

putComment

public void putComment(com.google.gerrit.reviewdb.client.PatchLineComment comment)

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

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.

Class ChangeUpdate

Nested Class Summary

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

Field Summary

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

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

Method Summary

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

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

Methods inherited from class java.lang.Object

Method Detail

setStatus

putApproval

removeApproval

submit

setSubject

setChangeMessage

putComment

putReviewer

removeReviewer

commit

getRefName

onSave

getProjectName