com.google.gerrit.extensions.api.changes

Interface FileApi

All Known Implementing Classes:

FileApi.NotImplemented

public interface FileApi

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	FileApi.BlameRequest
static class	FileApi.DiffRequest
static class	FileApi.NotImplemented A default implementation which allows source compatibility when adding new methods to the interface.

Method Summary

Modifier and Type	Method and Description
FileApi.BlameRequest	blameRequest() Creates a request to retrieve the blame information.
BinaryResult	content()
DiffInfo	diff() Diff against the revision's parent version of the file.
DiffInfo	diff(int parent)
DiffInfo	diff(java.lang.String base)
FileApi.DiffRequest	diffRequest() Creates a request to retrieve the diff.
void	setReviewed(boolean reviewed) Set the file reviewed or not reviewed

Method Detail

content

BinaryResult content()
              throws RestApiException

Throws:

RestApiException

diff

DiffInfo diff()
       throws RestApiException

Diff against the revision's parent version of the file.

Throws:

RestApiException

diff

DiffInfo diff(java.lang.String base)
       throws RestApiException

Parameters:

base - revision id of the revision to be used as the diff base

Throws:

RestApiException

diff

DiffInfo diff(int parent)
       throws RestApiException

Parameters:

parent - 1-based parent number to diff against

Throws:

RestApiException

diffRequest

FileApi.DiffRequest diffRequest()
                         throws RestApiException

Creates a request to retrieve the diff. On the returned request formatting options for the diff can be set.

Throws:

RestApiException

setReviewed

void setReviewed(boolean reviewed)
          throws RestApiException

Set the file reviewed or not reviewed

Throws:

RestApiException

blameRequest

FileApi.BlameRequest blameRequest()
                           throws RestApiException

Creates a request to retrieve the blame information. On the returned request formatting options for the blame request can be set.

Throws:

RestApiException