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

Class Files.ListFiles

java.lang.Object

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

All Implemented Interfaces:

ETagView<RevisionResource>, RestReadView<RevisionResource>, RestView<RevisionResource>

Enclosing class:

Files

public static final class Files.ListFiles
extends Object
implements ETagView<RevisionResource>

Method Summary

Modifier and Type	Method	Description
Response<?>	apply(RevisionResource resource)	Process the view operation by reading from the resource.
String	getETag(RevisionResource resource)
Files.ListFiles	setBase(String base)
Files.ListFiles	setParent(int parentNum)
Files.ListFiles	setQuery(String query)
Files.ListFiles	setReviewed(boolean r)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

setReviewed

public Files.ListFiles setReviewed(boolean r)

apply

public Response<?> apply(RevisionResource resource)
                  throws RestApiException,
org.eclipse.jgit.errors.RepositoryNotFoundException,
IOException,
PatchListNotAvailableException,
PermissionBackendException

Description copied from interface: RestReadView

Process the view operation by reading from the resource.

The value of the returned response is automatically converted to JSON unless it is a BinaryResult.

The returned response defines the status code that is returned to the client. For RestReadViews this is usually 200 OK, but other 2XX or 3XX status codes are also possible (e.g. Response.Redirect can be returned for 302 Found).

Throwing a subclass of RestApiException results in a 4XX response to the client. For any other exception the client will get a 500 Internal Server Error response.

Specified by:

apply in interface RestReadView<RevisionResource>

Parameters:

resource - resource to read

Returns:

response to return to the client

Throws:

AuthException - the caller is not permitted to access this view.

BadRequestException - the request was incorrectly specified and cannot be handled by this view.

ResourceConflictException - the resource state does not permit this view to make the changes at this time.

RestApiException

org.eclipse.jgit.errors.RepositoryNotFoundException

IOException

PatchListNotAvailableException

PermissionBackendException

setQuery

public Files.ListFiles setQuery(String query)

setBase

public Files.ListFiles setBase(String base)

setParent

public Files.ListFiles setParent(int parentNum)

getETag

public String getETag(RevisionResource resource)

Specified by:

getETag in interface ETagView<RevisionResource>