ChangeEditModifier (Gerrit Review Plugin API Documentation)

java.lang.Object
- com.google.gerrit.server.edit.ChangeEditModifier

```
public class ChangeEditModifier
extends Object
```
Utility functions to manipulate change edits.
This class contains methods to modify edit's content. For retrieving, publishing and deleting edit see ChangeEditUtil.

Method Summary

Methods
Modifier and Type	Method and Description
`org.eclipse.jgit.lib.RefUpdate.Result`	`createEdit(com.google.gerrit.reviewdb.client.Change change, com.google.gerrit.reviewdb.client.PatchSet ps)` Create new change edit.
`org.eclipse.jgit.lib.RefUpdate.Result`	`deleteFile(ChangeEdit edit, String file)` Delete file in existing change edit.
`org.eclipse.jgit.lib.RefUpdate.Result`	`modifyFile(ChangeEdit edit, String file, com.google.gerrit.extensions.restapi.RawInput content)` Modify file in existing change edit from its base commit.
`org.eclipse.jgit.lib.RefUpdate.Result`	`modifyMessage(ChangeEdit edit, String msg)` Modify commit message in existing change edit.
`void`	`rebaseEdit(ChangeEdit edit, com.google.gerrit.reviewdb.client.PatchSet current)` Rebase change edit on latest patch set
`org.eclipse.jgit.lib.RefUpdate.Result`	`renameFile(ChangeEdit edit, String file, String newFile)` Rename file in existing change edit.
`org.eclipse.jgit.lib.RefUpdate.Result`	`restoreFile(ChangeEdit edit, String file)` Restore file in existing change edit.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

createEdit

public org.eclipse.jgit.lib.RefUpdate.Result createEdit(com.google.gerrit.reviewdb.client.Change change,
                                               com.google.gerrit.reviewdb.client.PatchSet ps)
                                                 throws com.google.gerrit.extensions.restapi.AuthException,
                                                        IOException,
                                                        com.google.gerrit.extensions.restapi.ResourceConflictException,
                                                        com.google.gwtorm.server.OrmException

Create new change edit.

Parameters:: change - to create change edit for; ps - patch set to create change edit on
Returns:: result
Throws:: com.google.gerrit.extensions.restapi.AuthException; IOException; com.google.gerrit.extensions.restapi.ResourceConflictException - When change edit already exists for the change; com.google.gwtorm.server.OrmException

rebaseEdit

public void rebaseEdit(ChangeEdit edit,
              com.google.gerrit.reviewdb.client.PatchSet current)
                throws com.google.gerrit.extensions.restapi.AuthException,
                       com.google.gerrit.extensions.restapi.ResourceConflictException,
                       InvalidChangeOperationException,
                       IOException

Rebase change edit on latest patch set

Parameters:: edit - change edit that contains edit to rebase; current - patch set to rebase the edit on
Throws:: com.google.gerrit.extensions.restapi.AuthException; com.google.gerrit.extensions.restapi.ResourceConflictException - thrown if rebase fails due to merge conflicts; InvalidChangeOperationException; IOException

modifyMessage

public org.eclipse.jgit.lib.RefUpdate.Result modifyMessage(ChangeEdit edit,
                                                  String msg)
                                                    throws com.google.gerrit.extensions.restapi.AuthException,
                                                           InvalidChangeOperationException,
                                                           IOException,
                                                           UnchangedCommitMessageException

Modify commit message in existing change edit.

Parameters:: edit - change edit; msg - new commit message
Returns:: result
Throws:: com.google.gerrit.extensions.restapi.AuthException; InvalidChangeOperationException; IOException; UnchangedCommitMessageException

modifyFile

public org.eclipse.jgit.lib.RefUpdate.Result modifyFile(ChangeEdit edit,
                                               String file,
                                               com.google.gerrit.extensions.restapi.RawInput content)
                                                 throws com.google.gerrit.extensions.restapi.AuthException,
                                                        InvalidChangeOperationException,
                                                        IOException

Modify file in existing change edit from its base commit.

Parameters:: edit - change edit; file - path to modify; content - new content
Returns:: result
Throws:: com.google.gerrit.extensions.restapi.AuthException; InvalidChangeOperationException; IOException

deleteFile

public org.eclipse.jgit.lib.RefUpdate.Result deleteFile(ChangeEdit edit,
                                               String file)
                                                 throws com.google.gerrit.extensions.restapi.AuthException,
                                                        InvalidChangeOperationException,
                                                        IOException

Delete file in existing change edit.

Parameters:: edit - change edit; file - path to delete
Returns:: result
Throws:: com.google.gerrit.extensions.restapi.AuthException; InvalidChangeOperationException; IOException

renameFile

public org.eclipse.jgit.lib.RefUpdate.Result renameFile(ChangeEdit edit,
                                               String file,
                                               String newFile)
                                                 throws com.google.gerrit.extensions.restapi.AuthException,
                                                        InvalidChangeOperationException,
                                                        IOException

Rename file in existing change edit.

Parameters:: edit - change edit; file - path to rename; newFile - path to rename the file to
Returns:: result
Throws:: com.google.gerrit.extensions.restapi.AuthException; InvalidChangeOperationException; IOException

restoreFile

public org.eclipse.jgit.lib.RefUpdate.Result restoreFile(ChangeEdit edit,
                                                String file)
                                                  throws com.google.gerrit.extensions.restapi.AuthException,
                                                         InvalidChangeOperationException,
                                                         IOException

Restore file in existing change edit.

Parameters:: edit - change edit; file - path to restore
Returns:: result
Throws:: com.google.gerrit.extensions.restapi.AuthException; InvalidChangeOperationException; IOException

Class ChangeEditModifier