com.google.gerrit.server.restapi.account

Class StarredChanges

java.lang.Object

com.google.gerrit.server.restapi.account.StarredChanges

All Implemented Interfaces:

ChildCollection<AccountResource,AccountResource.StarredChange>, RestCollection<AccountResource,AccountResource.StarredChange>, RestView<AccountResource>

public class StarredChanges
extends java.lang.Object
implements ChildCollection<AccountResource,AccountResource.StarredChange>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StarredChanges.Create
static class	StarredChanges.Delete
static class	StarredChanges.EmptyInput
static class	StarredChanges.Put

Method Summary

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

parse

public AccountResource.StarredChange parse(AccountResource parent,
                                           IdString id)
                                    throws RestApiException,
                                           PermissionBackendException,
                                           java.io.IOException

Description copied from interface: RestCollection

Parse a path component into a resource handle.

Specified by:

parse in interface RestCollection<AccountResource,AccountResource.StarredChange>

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.

RestApiException

PermissionBackendException

java.io.IOException

views

public DynamicMap<RestView<AccountResource.StarredChange>> 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<AccountResource,AccountResource.StarredChange>

Returns:

map of views.

list

public RestView<AccountResource> list()
                               throws ResourceNotFoundException

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<AccountResource,AccountResource.StarredChange>

Returns:

view to list the collection.

Throws:

ResourceNotFoundException - if the collection doesn't support listing.