Package com.google.gerrit.server.restapi.config

Class IndexVersionsCollection

java.lang.Object

com.google.gerrit.server.restapi.config.IndexVersionsCollection

All Implemented Interfaces:

ChildCollection<IndexResource,IndexVersionResource>, RestCollection<IndexResource,IndexVersionResource>, RestView<IndexResource>

public class IndexVersionsCollection
extends Object
implements ChildCollection<IndexResource,IndexVersionResource>

Method Summary

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

list

public RestView<IndexResource> 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<IndexResource,IndexVersionResource>

Returns:

view to list the collection.

Throws:

RestApiException - if the collection cannot be listed.

parse

public IndexVersionResource parse(IndexResource parent,
 IdString id)
                           throws ResourceNotFoundException,
Exception

Description copied from interface: RestCollection

Parse a path component into a resource handle.

Specified by:

parse in interface RestCollection<IndexResource,IndexVersionResource>

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.

Exception - if the implementation had any errors converting to a resource handle. This results in an HTTP 500 Internal Server Error.

views

public DynamicMap<RestView<IndexVersionResource>> 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<IndexResource,IndexVersionResource>

Returns:

map of views.