ChangeDraftUpdate (Gerrit Review Plugin API Documentation)

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

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

```
public class ChangeDraftUpdate
extends AbstractChangeUpdate
```
A single delta to apply atomically to a change.
This delta contains only draft comments on a single patch set of a change by a single author. This delta will become a single commit in the All-Users repository.
This class is not thread safe.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ChangeDraftUpdate.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

Methods
Modifier and Type	Method and Description
`org.eclipse.jgit.revwalk.RevCommit`	`commit()`
`void`	`deleteComment(com.google.gerrit.reviewdb.client.PatchLineComment c)`
`void`	`deleteCommentIfPresent(com.google.gerrit.reviewdb.client.PatchLineComment c)` Deletes a PatchLineComment from the list of drafts only if it existed previously as a draft.
`protected com.google.gerrit.reviewdb.client.Project.NameKey`	`getProjectName()`
`protected java.lang.String`	`getRefName()`
`void`	`insertComment(com.google.gerrit.reviewdb.client.PatchLineComment c)`
`protected boolean`	`onSave(org.eclipse.jgit.lib.CommitBuilder commit)` Save any changes to the metadata in a commit.
`void`	`updateComment(com.google.gerrit.reviewdb.client.PatchLineComment c)`
`void`	`upsertComment(com.google.gerrit.reviewdb.client.PatchLineComment c)`
`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

insertComment

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

Throws:: com.google.gwtorm.server.OrmException

upsertComment

public void upsertComment(com.google.gerrit.reviewdb.client.PatchLineComment c)

updateComment

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

Throws:: com.google.gwtorm.server.OrmException

deleteComment

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

Throws:: com.google.gwtorm.server.OrmException

deleteCommentIfPresent
```
public void deleteCommentIfPresent(com.google.gerrit.reviewdb.client.PatchLineComment c)
                            throws com.google.gwtorm.server.OrmException
```
Deletes a PatchLineComment from the list of drafts only if it existed previously as a draft. If it wasn't a draft previously, this is a no-op.

Throws:

com.google.gwtorm.server.OrmException

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

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.

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)
                  throws java.io.IOException,
                         org.eclipse.jgit.errors.ConfigInvalidException
```
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.

Throws:

java.io.IOException

org.eclipse.jgit.errors.ConfigInvalidException

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method