Package com.google.gerrit.server.restapi.change

Class ChangeMessages

java.lang.Object

com.google.gerrit.server.restapi.change.ChangeMessages

All Implemented Interfaces:

ChildCollection<ChangeResource,ChangeMessageResource>, RestCollection<ChangeResource,ChangeMessageResource>, RestView<ChangeResource>

public class ChangeMessages
extends Object
implements ChildCollection<ChangeResource,ChangeMessageResource>

Method Summary

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

Returns:

map of views.

list

public ListChangeMessages 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<ChangeResource,ChangeMessageResource>

Returns:

view to list the collection.

parse

public ChangeMessageResource parse(ChangeResource parent,
                                   IdString id)
                            throws Exception

Description copied from interface: RestCollection

Parse a path component into a resource handle.

Specified by:

parse in interface RestCollection<ChangeResource,ChangeMessageResource>

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.