Submit (Gerrit Review Plugin API Documentation)

java.lang.Object
- com.google.gerrit.server.change.Submit

All Implemented Interfaces:

com.google.gerrit.extensions.restapi.RestModifyView<RevisionResource,com.google.gerrit.extensions.api.changes.SubmitInput>, com.google.gerrit.extensions.restapi.RestView<RevisionResource>, com.google.gerrit.extensions.webui.UiAction<RevisionResource>
```
public class Submit
extends java.lang.Object
implements com.google.gerrit.extensions.restapi.RestModifyView<RevisionResource,com.google.gerrit.extensions.api.changes.SubmitInput>, com.google.gerrit.extensions.webui.UiAction<RevisionResource>
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Submit.CurrentRevision

static class Submit.Output

static class Submit.Status
- Nested classes/interfaces inherited from interface com.google.gerrit.extensions.webui.UiAction
  com.google.gerrit.extensions.webui.UiAction.Description

Nested Classes
Modifier and Type	Class and Description
`static class`	`Submit.CurrentRevision`
`static class`	`Submit.Output`
`static class`	`Submit.Status`

Method Summary

Methods
Modifier and Type	Method and Description
`Submit.Output`	`apply(RevisionResource rsrc, com.google.gerrit.extensions.api.changes.SubmitInput input)`
`com.google.gerrit.reviewdb.client.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.
`com.google.gerrit.extensions.webui.UiAction.Description`	`getDescription(RevisionResource resource)`
`com.google.gerrit.reviewdb.client.Change`	`submit(RevisionResource rsrc, IdentifiedUser caller, boolean force)`

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,
                  com.google.gerrit.extensions.api.changes.SubmitInput input)
                    throws com.google.gerrit.extensions.restapi.AuthException,
                           com.google.gerrit.extensions.restapi.ResourceConflictException,
                           org.eclipse.jgit.errors.RepositoryNotFoundException,
                           java.io.IOException,
                           com.google.gwtorm.server.OrmException,
                           com.google.gerrit.extensions.restapi.UnprocessableEntityException

Specified by:: apply in interface com.google.gerrit.extensions.restapi.RestModifyView<RevisionResource,com.google.gerrit.extensions.api.changes.SubmitInput>
Throws:: com.google.gerrit.extensions.restapi.AuthException; com.google.gerrit.extensions.restapi.ResourceConflictException; org.eclipse.jgit.errors.RepositoryNotFoundException; java.io.IOException; com.google.gwtorm.server.OrmException; com.google.gerrit.extensions.restapi.UnprocessableEntityException

getDescription
```
public com.google.gerrit.extensions.webui.UiAction.Description getDescription(RevisionResource resource)
```
Specified by:

getDescription in interface com.google.gerrit.extensions.webui.UiAction<RevisionResource>

getConflictMessage
```
public com.google.gerrit.reviewdb.client.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

submit

public com.google.gerrit.reviewdb.client.Change submit(RevisionResource rsrc,
                                              IdentifiedUser caller,
                                              boolean force)
                                                throws com.google.gerrit.extensions.restapi.ResourceConflictException,
                                                       com.google.gwtorm.server.OrmException,
                                                       java.io.IOException

Throws:: com.google.gerrit.extensions.restapi.ResourceConflictException; com.google.gwtorm.server.OrmException; java.io.IOException

Class Submit

Nested Class Summary

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

Method Summary

Methods inherited from class java.lang.Object

Method Detail

apply

getDescription

getConflictMessage

submit