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

Class ChangeEdits

java.lang.Object

com.google.gerrit.server.restapi.change.ChangeEdits

All Implemented Interfaces:

ChildCollection<ChangeResource,ChangeEditResource>, RestCollection<ChangeResource,ChangeEditResource>, RestView<ChangeResource>

public class ChangeEdits
extends Object
implements ChildCollection<ChangeResource,ChangeEditResource>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ChangeEdits.Create	Create handler that is activated when collection element is accessed but doesn't exist, e.
static class	ChangeEdits.DeleteContent	Handler to delete a file.
static class	ChangeEdits.DeleteFile
static class	ChangeEdits.Detail
static class	ChangeEdits.EditMessage
static class	ChangeEdits.Get
static class	ChangeEdits.GetMessage
static class	ChangeEdits.GetMeta
static class	ChangeEdits.Post	Post to edit collection resource.
static class	ChangeEdits.Put	Put handler that is activated when PUT request is called on collection element.

Method Summary

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

Returns:

map of views.

list

public RestView<ChangeResource> 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,ChangeEditResource>

Returns:

view to list the collection.

parse

public ChangeEditResource parse(ChangeResource rsrc,
                                IdString id)
                         throws ResourceNotFoundException,
                                AuthException,
                                IOException

Description copied from interface: RestCollection

Parse a path component into a resource handle.

Specified by:

parse in interface RestCollection<ChangeResource,ChangeEditResource>

Parameters:

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

AuthException

IOException