com.google.gerrit.server.edit

Class ChangeEditUtil

java.lang.Object

com.google.gerrit.server.edit.ChangeEditUtil

public class ChangeEditUtil
extends java.lang.Object

Utility functions to manipulate change edits.

This class contains methods to retrieve, publish and delete edits. For changing edits see ChangeEditModifier.

Method Summary

Modifier and Type	Method and Description
java.util.Optional<ChangeEdit>	byChange(Change change) Retrieve edit for a change and the user from the request scope.
java.util.Optional<ChangeEdit>	byChange(ChangeControl ctl) Retrieve edit for a change and the given user.
void	delete(ChangeEdit edit) Delete change edit.
void	publish(ChangeEdit edit, NotifyHandling notify, com.google.common.collect.ListMultimap<RecipientType,Account.Id> accountsToNotify) Promote change edit to patch set, by squashing the edit into its parent.

Methods inherited from class java.lang.Object

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

Method Detail

byChange

public java.util.Optional<ChangeEdit> byChange(Change change)
                                        throws AuthException,
                                               java.io.IOException,
                                               com.google.gwtorm.server.OrmException

Retrieve edit for a change and the user from the request scope.

At most one change edit can exist per user and change.

Parameters:

change -

Returns:

edit for this change for this user, if present.

Throws:

AuthException

java.io.IOException

com.google.gwtorm.server.OrmException

byChange

public java.util.Optional<ChangeEdit> byChange(ChangeControl ctl)
                                        throws AuthException,
                                               java.io.IOException

Retrieve edit for a change and the given user.

At most one change edit can exist per user and change.

Parameters:

ctl - control with user to retrieve change edits for.

Returns:

edit for this change for this user, if present.

Throws:

AuthException - if this is not a logged-in user.

java.io.IOException - if an error occurs.

publish

public void publish(ChangeEdit edit,
                    NotifyHandling notify,
                    com.google.common.collect.ListMultimap<RecipientType,Account.Id> accountsToNotify)
             throws java.io.IOException,
                    com.google.gwtorm.server.OrmException,
                    RestApiException,
                    UpdateException

Promote change edit to patch set, by squashing the edit into its parent.

Parameters:

edit - change edit to publish

notify - Notify handling that defines to whom email notifications should be sent after the change edit is published.

accountsToNotify - Accounts that should be notified after the change edit is published.

Throws:

java.io.IOException

com.google.gwtorm.server.OrmException

UpdateException

RestApiException

delete

public void delete(ChangeEdit edit)
            throws java.io.IOException,
                   com.google.gwtorm.server.OrmException

Delete change edit.

Parameters:

edit - change edit to delete

Throws:

java.io.IOException

com.google.gwtorm.server.OrmException