Package com.google.gerrit.server.restapi.project

Class DeleteLabel

java.lang.Object

com.google.gerrit.server.restapi.project.DeleteLabel

All Implemented Interfaces:

RestModifyView<LabelResource,InputWithCommitMessage>, RestView<LabelResource>

public class DeleteLabel
extends Object
implements RestModifyView<LabelResource,InputWithCommitMessage>

Constructor Summary

Constructors

Constructor	Description
DeleteLabel(com.google.inject.Provider<CurrentUser> user, PermissionBackend permissionBackend, MetaDataUpdate.User updateFactory, ProjectConfig.Factory projectConfigFactory, ProjectCache projectCache)

Method Summary

Modifier and Type	Method	Description
Response<?>	apply(LabelResource rsrc, InputWithCommitMessage input)	Process the view operation by altering the resource.
boolean	deleteLabel(ProjectConfig config, String labelName)	Delete the given label from the given project config.

Methods inherited from class java.lang.Object

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

Constructor Detail

DeleteLabel

@Inject
public DeleteLabel(com.google.inject.Provider<CurrentUser> user,
                   PermissionBackend permissionBackend,
                   MetaDataUpdate.User updateFactory,
                   ProjectConfig.Factory projectConfigFactory,
                   ProjectCache projectCache)

Method Detail

apply

public Response<?> apply(LabelResource rsrc,
                         InputWithCommitMessage input)
                  throws AuthException,
                         ResourceNotFoundException,
                         PermissionBackendException,
                         IOException,
                         org.eclipse.jgit.errors.ConfigInvalidException

Description copied from interface: RestModifyView

Process the view operation by altering the resource.

The value of the returned response is automatically converted to JSON unless it is a BinaryResult.

The returned response defines the status code that is returned to the client. For RestModifyViews this is usually 200 OK, but other 2XX or 3XX status codes are also possible (e.g. 202 Accepted if a background task was scheduled, 204 No Content if no content is returned, 302 Found for a redirect).

Throwing a subclass of RestApiException results in a 4XX response to the client. For any other exception the client will get a 500 Internal Server Error response.

Specified by:

apply in interface RestModifyView<LabelResource,InputWithCommitMessage>

Parameters:

rsrc - resource to modify

input - input after parsing from request

Returns:

response to return to the client

Throws:

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

ResourceNotFoundException

PermissionBackendException

IOException

org.eclipse.jgit.errors.ConfigInvalidException

deleteLabel

public boolean deleteLabel(ProjectConfig config,
                           String labelName)

Delete the given label from the given project config.

Parameters:

config - the project config from which the label should be deleted

labelName - the name of the label that should be deleted

Returns:

true if the label was deleted, false if the label was not found