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

Class LabelsCollection

java.lang.Object

com.google.gerrit.server.restapi.project.LabelsCollection

All Implemented Interfaces:

ChildCollection<ProjectResource,LabelResource>, RestCollection<ProjectResource,LabelResource>, RestView<ProjectResource>

public class LabelsCollection
extends Object
implements ChildCollection<ProjectResource,LabelResource>

Method Summary

Modifier and Type	Method	Description
RestView<ProjectResource>	list()	Create a view to list the contents of the collection.
LabelResource	parse(ProjectResource parent, IdString id)	Parse a path component into a resource handle.
DynamicMap<RestView<LabelResource>>	views()	Get the views that support this collection.

Methods inherited from class java.lang.Object

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

Method Detail

list

public RestView<ProjectResource> list()
                               throws RestApiException

Description copied from interface: RestCollection

Create a view to list the contents of the collection.

The returned view should accept the parent type to scope the search, and may want to take a "q" parameter option to narrow the results.

Specified by:

list in interface RestCollection<ProjectResource,LabelResource>

Returns:

view to list the collection.

Throws:

ResourceNotFoundException - if the collection doesn't support listing.

AuthException - if the collection requires authentication.

RestApiException - if the collection cannot be listed.

parse

public LabelResource parse(ProjectResource parent,
                           IdString id)
                    throws AuthException,
                           ResourceNotFoundException,
                           PermissionBackendException

Description copied from interface: RestCollection

Parse a path component into a resource handle.

Specified by:

parse in interface RestCollection<ProjectResource,LabelResource>

Parameters:

parent - the handle to the collection.

id - string identifier supplied by the client. In a URL such as /changes/1234/abandon this string is "1234".

Returns:

a resource handle for the identified object.

Throws:

ResourceNotFoundException - the object does not exist, or the caller is not permitted to know if the resource exists.

AuthException

PermissionBackendException

views

public DynamicMap<RestView<LabelResource>> views()

Description copied from interface: RestCollection

Get the views that support this collection.

Within a resource the views are accessed as RESOURCE/plugin~view.

Specified by:

views in interface RestCollection<ProjectResource,LabelResource>

Returns:

map of views.