com.google.gerrit.server.restapi.group

Class MembersCollection

java.lang.Object

com.google.gerrit.server.restapi.group.MembersCollection

All Implemented Interfaces:

ChildCollection<GroupResource,MemberResource>, RestCollection<GroupResource,MemberResource>, RestView<GroupResource>

public class MembersCollection
extends java.lang.Object
implements ChildCollection<GroupResource,MemberResource>

Method Summary

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

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<GroupResource,MemberResource>

Returns:

view to list the collection.

Throws:

ResourceNotFoundException - if the collection doesn't support listing.

AuthException - if the collection requires authentication.

parse

public MemberResource parse(GroupResource parent,
                            IdString id)
                     throws com.google.gerrit.server.restapi.group.NotInternalGroupException,
                            AuthException,
                            ResourceNotFoundException,
                            java.io.IOException,
                            org.eclipse.jgit.errors.ConfigInvalidException

Description copied from interface: RestCollection

Parse a path component into a resource handle.

Specified by:

parse in interface RestCollection<GroupResource,MemberResource>

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.

com.google.gerrit.server.restapi.group.NotInternalGroupException

AuthException

java.io.IOException

org.eclipse.jgit.errors.ConfigInvalidException

views

public DynamicMap<RestView<MemberResource>> 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<GroupResource,MemberResource>

Returns:

map of views.