Package com.google.gerrit.server.restapi.project

Class FilesInCommitCollection

java.lang.Object

com.google.gerrit.server.restapi.project.FilesInCommitCollection

All Implemented Interfaces:

ChildCollection<CommitResource,FileResource>, RestCollection<CommitResource,FileResource>, RestView<CommitResource>

public class FilesInCommitCollection
extends Object
implements ChildCollection<CommitResource,FileResource>

like FilesCollection, but for commits that are specified as hex ID, rather than branch names.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FilesInCommitCollection.ListFiles

Method Summary

Modifier and Type	Method	Description
RestView<CommitResource>	list()	Create a view to list the contents of the collection.
FileResource	parse(CommitResource parent, 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 Detail

list

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

Returns:

view to list the collection.

Throws:

ResourceNotFoundException - if the collection doesn't support listing.

parse

public FileResource parse(CommitResource parent,
                          IdString id)
                   throws ResourceNotFoundException,
                          IOException

Description copied from interface: RestCollection

Parse a path component into a resource handle.

Specified by:

parse in interface RestCollection<CommitResource,FileResource>

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.

IOException

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<CommitResource,FileResource>

Returns:

map of views.