com.google.gerrit.server.restapi.change

Class Comments

java.lang.Object

com.google.gerrit.server.restapi.change.Comments

All Implemented Interfaces:

ChildCollection<RevisionResource,CommentResource>, RestCollection<RevisionResource,CommentResource>, RestView<RevisionResource>

public class Comments
extends java.lang.Object
implements ChildCollection<RevisionResource,CommentResource>

Method Summary

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

Returns:

map of views.

list

public ListRevisionComments 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<RevisionResource,CommentResource>

Returns:

view to list the collection.

parse

public CommentResource parse(RevisionResource rev,
                             IdString id)
                      throws ResourceNotFoundException

Description copied from interface: RestCollection

Parse a path component into a resource handle.

Specified by:

parse in interface RestCollection<RevisionResource,CommentResource>

Parameters:

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