com.google.gerrit.server.edit

Class ChangeEditModifier

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

Modifier and Type	Method and Description
void	createEdit(org.eclipse.jgit.lib.Repository repository, ChangeControl changeControl) Creates a new change edit.
void	deleteFile(org.eclipse.jgit.lib.Repository repository, ChangeControl changeControl, String file) Deletes a file from the Git tree of a change edit.
void	modifyFile(org.eclipse.jgit.lib.Repository repository, ChangeControl changeControl, String filePath, RawInput newContent) Modifies the contents of a file of a change edit.
void	modifyMessage(org.eclipse.jgit.lib.Repository repository, ChangeControl changeControl, String newCommitMessage) Modifies the commit message of a change edit.
void	rebaseEdit(org.eclipse.jgit.lib.Repository repository, ChangeControl changeControl) Rebase change edit on latest patch set
void	renameFile(org.eclipse.jgit.lib.Repository repository, ChangeControl changeControl, String currentFilePath, String newFilePath) Renames a file of a change edit or moves it to another directory.
void	restoreFile(org.eclipse.jgit.lib.Repository repository, ChangeControl changeControl, String file) Restores a file of a change edit to the state it was in before the patch set on which the change edit is based.

Methods inherited from class java.lang.Object

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

Method Detail

createEdit

public void createEdit(org.eclipse.jgit.lib.Repository repository,
                       ChangeControl changeControl)
                throws AuthException,
                       IOException,
                       InvalidChangeOperationException,
                       com.google.gwtorm.server.OrmException

Creates a new change edit.

Parameters:

repository - the affected Git repository

changeControl - the ChangeControl of the change for which the change edit should be created

Throws:

AuthException - if the user isn't authenticated or not allowed to use change edits

InvalidChangeOperationException - if a change edit already existed for the change

IOException

com.google.gwtorm.server.OrmException

rebaseEdit

public void rebaseEdit(org.eclipse.jgit.lib.Repository repository,
                       ChangeControl changeControl)
                throws AuthException,
                       InvalidChangeOperationException,
                       IOException,
                       com.google.gwtorm.server.OrmException,
                       MergeConflictException

Rebase change edit on latest patch set

Parameters:

repository - the affected Git repository

changeControl - the ChangeControl of the change whose change edit should be rebased

Throws:

AuthException - if the user isn't authenticated or not allowed to use change edits

InvalidChangeOperationException - if a change edit doesn't exist for the specified change, the change edit is already based on the latest patch set, or the change represents the root commit

MergeConflictException - if rebase fails due to merge conflicts

IOException

com.google.gwtorm.server.OrmException

modifyMessage

public void modifyMessage(org.eclipse.jgit.lib.Repository repository,
                          ChangeControl changeControl,
                          String newCommitMessage)
                   throws AuthException,
                          IOException,
                          UnchangedCommitMessageException,
                          com.google.gwtorm.server.OrmException

Modifies the commit message of a change edit. If the change edit doesn't exist, a new one will be created based on the current patch set.

Parameters:

repository - the affected Git repository

changeControl - the ChangeControl of the change whose change edit's message should be modified

newCommitMessage - the new commit message

Throws:

AuthException - if the user isn't authenticated or not allowed to use change edits

UnchangedCommitMessageException - if the commit message is the same as before

IOException

com.google.gwtorm.server.OrmException

modifyFile

public void modifyFile(org.eclipse.jgit.lib.Repository repository,
                       ChangeControl changeControl,
                       String filePath,
                       RawInput newContent)
                throws AuthException,
                       InvalidChangeOperationException,
                       IOException,
                       com.google.gwtorm.server.OrmException

Modifies the contents of a file of a change edit. If the change edit doesn't exist, a new one will be created based on the current patch set.

Parameters:

repository - the affected Git repository

changeControl - the ChangeControl of the change whose change edit should be modified

filePath - the path of the file whose contents should be modified

newContent - the new file content

Throws:

AuthException - if the user isn't authenticated or not allowed to use change edits

InvalidChangeOperationException - if the file already had the specified content

IOException

com.google.gwtorm.server.OrmException

deleteFile

public void deleteFile(org.eclipse.jgit.lib.Repository repository,
                       ChangeControl changeControl,
                       String file)
                throws AuthException,
                       InvalidChangeOperationException,
                       IOException,
                       com.google.gwtorm.server.OrmException

Deletes a file from the Git tree of a change edit. If the change edit doesn't exist, a new one will be created based on the current patch set.

Parameters:

repository - the affected Git repository

changeControl - the ChangeControl of the change whose change edit should be modified

file - path of the file which should be deleted

Throws:

AuthException - if the user isn't authenticated or not allowed to use change edits

InvalidChangeOperationException - if the file does not exist

IOException

com.google.gwtorm.server.OrmException

renameFile

public void renameFile(org.eclipse.jgit.lib.Repository repository,
                       ChangeControl changeControl,
                       String currentFilePath,
                       String newFilePath)
                throws AuthException,
                       InvalidChangeOperationException,
                       IOException,
                       com.google.gwtorm.server.OrmException

Renames a file of a change edit or moves it to another directory. If the change edit doesn't exist, a new one will be created based on the current patch set.

Parameters:

repository - the affected Git repository

changeControl - the ChangeControl of the change whose change edit should be modified

currentFilePath - the current path/name of the file

newFilePath - the desired path/name of the file

Throws:

AuthException - if the user isn't authenticated or not allowed to use change edits

InvalidChangeOperationException - if the file was already renamed to the specified new name

IOException

com.google.gwtorm.server.OrmException

restoreFile

public void restoreFile(org.eclipse.jgit.lib.Repository repository,
                        ChangeControl changeControl,
                        String file)
                 throws AuthException,
                        InvalidChangeOperationException,
                        IOException,
                        com.google.gwtorm.server.OrmException

Restores a file of a change edit to the state it was in before the patch set on which the change edit is based. If the change edit doesn't exist, a new one will be created based on the current patch set.

Parameters:

repository - the affected Git repository

changeControl - the ChangeControl of the change whose change edit should be modified

file - the path of the file which should be restored

Throws:

AuthException - if the user isn't authenticated or not allowed to use change edits

InvalidChangeOperationException - if the file was already restored

IOException

com.google.gwtorm.server.OrmException