com.google.gerrit.server.change

Class Submit

java.lang.Object

com.google.gerrit.server.change.Submit

All Implemented Interfaces:

RestModifyView<RevisionResource,SubmitInput>, RestView<RevisionResource>, UiAction<RevisionResource>

public class Submit
extends Object
implements RestModifyView<RevisionResource,SubmitInput>, UiAction<RevisionResource>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Submit.CurrentRevision
static class	Submit.Output
static class	Submit.TestSubmitInput Subclass of SubmitInput with special bits that may be flipped for testing purposes only.

Nested classes/interfaces inherited from interface com.google.gerrit.extensions.webui.UiAction

UiAction.Description

Method Summary

Modifier and Type	Method and Description
Submit.Output	apply(RevisionResource rsrc, SubmitInput input) Process the view operation by altering the resource.
ChangeMessage	getConflictMessage(RevisionResource rsrc) If the merge was attempted and it failed the system usually writes a comment as a ChangeMessage and sets status to NEW.
UiAction.Description	getDescription(RevisionResource resource) Get the description of the action customized for the resource.
Collection<ChangeData>	unmergeableChanges(ChangeSet cs)
static boolean	wholeTopicEnabled(org.eclipse.jgit.lib.Config config)

Methods inherited from class java.lang.Object

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

Method Detail

apply

public Submit.Output apply(RevisionResource rsrc,
                           SubmitInput input)
                    throws RestApiException,
                           org.eclipse.jgit.errors.RepositoryNotFoundException,
                           IOException,
                           com.google.gwtorm.server.OrmException

Description copied from interface: RestModifyView

Process the view operation by altering the resource.

Specified by:

apply in interface RestModifyView<RevisionResource,SubmitInput>

Parameters:

rsrc - resource to modify.

input - input after parsing from request.

Returns:

result to return to the client. Use BinaryResult to avoid automatic conversion to JSON.

Throws:

AuthException - the client is not permitted to access this view.

BadRequestException - the request was incorrectly specified and cannot be handled by this view.

ResourceConflictException - the resource state does not permit this view to make the changes at this time.

RestApiException

org.eclipse.jgit.errors.RepositoryNotFoundException

IOException

com.google.gwtorm.server.OrmException

getDescription

public UiAction.Description getDescription(RevisionResource resource)

Description copied from interface: UiAction

Get the description of the action customized for the resource.

Specified by:

getDescription in interface UiAction<RevisionResource>

Parameters:

resource - the resource the view would act upon if the action is invoked by the client. Information from the resource can be used to customize the description.

Returns:

a description of the action. The server will populate the id and method properties. If null the action will assumed unavailable and not presented. This is usually the same as setVisible(false).

getConflictMessage

public ChangeMessage getConflictMessage(RevisionResource rsrc)
                                 throws com.google.gwtorm.server.OrmException

If the merge was attempted and it failed the system usually writes a comment as a ChangeMessage and sets status to NEW. Find the relevant message and return it.

Throws:

com.google.gwtorm.server.OrmException

unmergeableChanges

public Collection<ChangeData> unmergeableChanges(ChangeSet cs)
                                          throws com.google.gwtorm.server.OrmException,
                                                 IOException

Throws:

com.google.gwtorm.server.OrmException

IOException

wholeTopicEnabled

public static boolean wholeTopicEnabled(org.eclipse.jgit.lib.Config config)