com.google.gerrit.server.restapi.change

Class Revisions

java.lang.Object

com.google.gerrit.server.restapi.change.Revisions

All Implemented Interfaces:

ChildCollection<ChangeResource,RevisionResource>, RestCollection<ChangeResource,RevisionResource>, RestView<ChangeResource>

public class Revisions
extends java.lang.Object
implements ChildCollection<ChangeResource,RevisionResource>

Method Summary

Modifier and Type	Method and Description
RestView<ChangeResource>	list() Create a view to list the contents of the collection.
RevisionResource	parse(ChangeResource change, IdString id) Parse a path component into a resource handle.
DynamicMap<RestView<RevisionResource>>	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

views

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

Returns:

map of views.

list

public RestView<ChangeResource> list()
                              throws ResourceNotFoundException

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

Returns:

view to list the collection.

Throws:

ResourceNotFoundException - if the collection doesn't support listing.

parse

public RevisionResource parse(ChangeResource change,
                              IdString id)
                       throws ResourceNotFoundException,
                              AuthException,
                              java.io.IOException,
                              PermissionBackendException

Description copied from interface: RestCollection

Parse a path component into a resource handle.

Specified by:

parse in interface RestCollection<ChangeResource,RevisionResource>

Parameters:

change - 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

java.io.IOException

PermissionBackendException