ChangeUpdate (Gerrit Review Plugin API Documentation)

java.lang.Object
- com.google.gerrit.server.git.VersionedMetaData
- - com.google.gerrit.server.notedb.ChangeUpdate

```
public class ChangeUpdate
extends VersionedMetaData
```
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.git.VersionedMetaData
  inserter, newTree, reader

Method Summary

Methods
Modifier and Type	Method and Description
`org.eclipse.jgit.revwalk.RevCommit`	`commit()`
`org.eclipse.jgit.revwalk.RevCommit`	`commit(MetaDataUpdate md)` Update this metadata branch, recording a new commit on its reference.
`com.google.gerrit.reviewdb.client.Change`	`getChange()`
`protected String`	`getRefName()`
`IdentifiedUser`	`getUser()`
`Date`	`getWhen()`
`protected void`	`onLoad()` Set up the metadata, parsing any state from the loaded revision.
`protected boolean`	`onSave(org.eclipse.jgit.lib.CommitBuilder commit)` Save any changes to the metadata in a commit.
`VersionedMetaData.BatchMetaDataUpdate`	`openUpdate()`
`VersionedMetaData.BatchMetaDataUpdate`	`openUpdate(MetaDataUpdate update)`
`void`	`putApproval(String label, short value)`
`void`	`putReviewer(com.google.gerrit.reviewdb.client.Account.Id reviewer, ReviewerState type)`
`void`	`removeApproval(String label)`
`void`	`removeReviewer(com.google.gerrit.reviewdb.client.Account.Id reviewer)`
`void`	`setPatchSetId(com.google.gerrit.reviewdb.client.PatchSet.Id psId)`
`void`	`setStatus(com.google.gerrit.reviewdb.client.Change.Status status)`
`void`	`setSubject(String subject)`
`void`	`submit(Iterable<com.google.gerrit.common.data.SubmitRecord> submitRecords)`

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

getChange

public com.google.gerrit.reviewdb.client.Change getChange()

getUser
```
public IdentifiedUser getUser()
```

getWhen
```
public Date getWhen()
```

setStatus

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

putApproval

public void putApproval(String label,
               short value)

removeApproval

public void removeApproval(String label)

submit

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

setSubject

public void setSubject(String subject)

setPatchSetId

public void setPatchSetId(com.google.gerrit.reviewdb.client.PatchSet.Id psId)

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(MetaDataUpdate md)
                                          throws IOException
```
Description copied from class: VersionedMetaData

Update this metadata branch, recording a new commit on its reference.

Overrides:

commit in class VersionedMetaData

Parameters:
md - helper information to define the update that will occur.

Returns:
the commit that was created

Throws:

IOException - if there is a storage problem and the update cannot be executed as requested or if it failed because of a concurrent update to the same reference

commit

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

Throws:: IOException

openUpdate

public VersionedMetaData.BatchMetaDataUpdate openUpdate(MetaDataUpdate update)
                                                 throws IOException

Overrides:: openUpdate in class VersionedMetaData
Throws:: IOException

openUpdate

public VersionedMetaData.BatchMetaDataUpdate openUpdate()
                                                 throws IOException

Throws:: IOException

getRefName
```
protected 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.

onLoad
```
protected void onLoad()
               throws IOException,
                      org.eclipse.jgit.errors.ConfigInvalidException
```
Description copied from class: VersionedMetaData

Set up the metadata, parsing any state from the loaded revision.

Specified by:

onLoad in class VersionedMetaData

Throws:

IOException

org.eclipse.jgit.errors.ConfigInvalidException

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.git.VersionedMetaData

Method Summary

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

Methods inherited from class java.lang.Object

Method Detail

getChange

getUser

getWhen

setStatus

putApproval

removeApproval

submit

setSubject

setPatchSetId

putReviewer

removeReviewer

commit

commit

openUpdate

openUpdate

getRefName

onSave

onLoad