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

Class GetDiff

java.lang.Object

com.google.gerrit.server.restapi.change.GetDiff

All Implemented Interfaces:

RestReadView<FileResource>, RestView<FileResource>

public class GetDiff
extends Object
implements RestReadView<FileResource>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GetDiff.ContextOptionHandler

Method Summary

Modifier and Type	Method	Description
Response<DiffInfo>	apply(FileResource resource)	Process the view operation by reading from the resource.
GetDiff	setBase(String base)
GetDiff	setContext(int context)
GetDiff	setIntraline(boolean intraline)
GetDiff	setParent(int parentNum)
GetDiff	setWhitespace(DiffPreferencesInfo.Whitespace whitespace)

Methods inherited from class java.lang.Object

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

Method Detail

apply

public Response<DiffInfo> apply(FileResource resource)
                         throws BadRequestException,
                                ResourceConflictException,
                                ResourceNotFoundException,
                                AuthException,
                                InvalidChangeOperationException,
                                IOException,
                                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<FileResource>

Parameters:

resource - resource to read

Returns:

response to return to the client

Throws:

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.

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

ResourceNotFoundException

InvalidChangeOperationException

IOException

PermissionBackendException

setBase

public GetDiff setBase(String base)

setParent

public GetDiff setParent(int parentNum)

setContext

public GetDiff setContext(int context)

setIntraline

public GetDiff setIntraline(boolean intraline)

setWhitespace

public GetDiff setWhitespace(DiffPreferencesInfo.Whitespace whitespace)