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 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.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
com.google.gerrit.extensions.webui.UiAction.Description

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)`
`static boolean`	`submittable(ChangeData cd)` Check if there are any problems with the given change.
`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,
                  com.google.gerrit.extensions.api.changes.SubmitInput input)
                    throws com.google.gerrit.extensions.restapi.RestApiException,
                           org.eclipse.jgit.errors.RepositoryNotFoundException,
                           IOException,
                           com.google.gwtorm.server.OrmException

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.RestApiException; org.eclipse.jgit.errors.RepositoryNotFoundException; IOException; com.google.gwtorm.server.OrmException

submittable
```
public static boolean submittable(ChangeData cd)
```
Check if there are any problems with the given change. It doesn't take any problems of related changes into account.

Parameters:
cd - the change to check for submittability

Returns:
if the change has any problems for submission

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

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)

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

submittable

getDescription

getConflictMessage

unmergeableChanges

wholeTopicEnabled