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

Class IndexCollection

java.lang.Object

com.google.gerrit.server.restapi.config.IndexCollection

All Implemented Interfaces:

ChildCollection<ConfigResource,IndexResource>, RestCollection<ConfigResource,IndexResource>, RestView<ConfigResource>

public class IndexCollection
extends Object
implements ChildCollection<ConfigResource,IndexResource>

Method Summary

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

parse

public IndexResource parse(ConfigResource parent,
 IdString id)
                    throws ResourceNotFoundException

Description copied from interface: RestCollection

Parse a path component into a resource handle.

Specified by:

parse in interface RestCollection<ConfigResource,IndexResource>

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.

list

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

Returns:

view to list the collection.

Throws:

RestApiException - if the collection cannot be listed.

views

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

Returns:

map of views.