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

Class Files

java.lang.Object

com.google.gerrit.server.restapi.change.Files

All Implemented Interfaces:

ChildCollection<RevisionResource,FileResource>, RestCollection<RevisionResource,FileResource>, RestView<RevisionResource>

public class Files
extends Object
implements ChildCollection<RevisionResource,FileResource>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Files.ListFiles

Method Summary

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

views

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

Returns:

map of views.

list

public RestView<RevisionResource> list()
                                throws 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<RevisionResource,FileResource>

Returns:

view to list the collection.

Throws:

AuthException - if the collection requires authentication.

parse

public FileResource parse(RevisionResource rev,
 IdString id)

Description copied from interface: RestCollection

Parse a path component into a resource handle.

Specified by:

parse in interface RestCollection<RevisionResource,FileResource>

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.