Package com.google.gerrit.server.restapi.change

Class ChangesCollection

java.lang.Object

com.google.gerrit.server.restapi.change.ChangesCollection

All Implemented Interfaces:

RestCollection<TopLevelResource,ChangeResource>

public class ChangesCollection
extends Object
implements RestCollection<TopLevelResource,ChangeResource>

Constructor Summary

Constructors

Constructor	Description
ChangesCollection(com.google.inject.Provider<CurrentUser> user, com.google.inject.Provider<QueryChanges> queryFactory, DynamicMap<RestView<ChangeResource>> views, ChangeFinder changeFinder, ChangeResource.Factory changeResourceFactory, PermissionBackend permissionBackend, ProjectCache projectCache)

Method Summary

Modifier and Type	Method	Description
QueryChanges	list()	Create a view to list the contents of the collection.
ChangeResource	parse(Change.Id id)
ChangeResource	parse(TopLevelResource root, IdString id)	Parse a path component into a resource handle.
ChangeResource	parse(ChangeNotes notes, CurrentUser user)
DynamicMap<RestView<ChangeResource>>	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

Constructor Detail

ChangesCollection

@Inject
public ChangesCollection(com.google.inject.Provider<CurrentUser> user,
                         com.google.inject.Provider<QueryChanges> queryFactory,
                         DynamicMap<RestView<ChangeResource>> views,
                         ChangeFinder changeFinder,
                         ChangeResource.Factory changeResourceFactory,
                         PermissionBackend permissionBackend,
                         ProjectCache projectCache)

Method Detail

list

public QueryChanges list()

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<TopLevelResource,ChangeResource>

Returns:

view to list the collection.

views

public DynamicMap<RestView<ChangeResource>> 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<TopLevelResource,ChangeResource>

Returns:

map of views.

parse

public ChangeResource parse(TopLevelResource root,
                            IdString id)
                     throws RestApiException,
                            PermissionBackendException,
                            IOException

Description copied from interface: RestCollection

Parse a path component into a resource handle.

Specified by:

parse in interface RestCollection<TopLevelResource,ChangeResource>

Parameters:

root - 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.

RestApiException

PermissionBackendException

IOException

parse

public ChangeResource parse(Change.Id id)
                     throws ResourceConflictException,
                            ResourceNotFoundException,
                            PermissionBackendException

Throws:

ResourceConflictException

ResourceNotFoundException

PermissionBackendException

parse

public ChangeResource parse(ChangeNotes notes,
                            CurrentUser user)