com.google.gerrit.extensions.restapi

Interface RestReadView<R extends RestResource>

Type Parameters:

R - type of resource the view reads.

All Superinterfaces:

RestView<R>

All Known Subinterfaces:

ETagView<R>

All Known Implementing Classes:

ChangeEdits.Detail, ChangeEdits.Get, ChangeEdits.GetMessage, ChangeEdits.GetMeta, ChangeIncludedIn, Check, CheckAccessReadView, CheckMergeability, CommitIncludedIn, DownloadContent, Files.ListFiles, FilesInCommitCollection.ListFiles, GetAccess, GetAccount, GetActive, GetAgreements, GetArchive, GetAssignee, GetAuditLog, GetAvatar, GetAvatarChangeUrl, GetBlame, GetBranch, GetCache, GetCapabilities, GetCapabilities.CheckOne, GetChange, GetChangeMessage, GetChildProject, GetComment, GetCommit, GetCommit, GetConfig, GetContent, GetContent, GetDashboard, GetDescription, GetDescription, GetDescription, GetDetail, GetDetail, GetDetail, GetDiff, GetDiffPreferences, GetDiffPreferences, GetDraftComment, GetEditPreferences, GetEditPreferences, GetEmail, GetEmails, GetExternalIds, GetGroup, GetGroups, GetHashtags, GetHead, GetMember, GetMergeList, GetName, GetName, GetOAuthToken, GetOptions, GetOwner, GetParent, GetPastAssignees, GetPatch, GetPreferences, GetPreferences, GetProject, GetPureRevert, GetReflog, GetRelated, GetReview, GetReviewer, GetRevisionActions, GetRobotComment, GetServerInfo, GetSshKey, GetSshKeys, GetStatistics, GetStatus, GetStatus, GetSubgroup, GetSummary, GetTag, GetTask, GetTopic, GetUsername, GetVersion, GetWatchedProjects, ListAccess, ListBranches, ListCaches, ListCapabilities, ListChangeComments, ListChangeDrafts, ListChangeMessages, ListChangeRobotComments, ListChildProjects, ListDashboards, ListGroups, ListMembers, ListPlugins, ListProjects, ListReviewers, ListRevisionComments, ListRevisionDrafts, ListRobotComments, ListSubgroups, ListTags, ListTasks, ListTopMenus, Mergeable, PreviewSubmit, QueryAccounts, QueryChanges, QueryGroups, QueryProjects, Stars.Get, Stars.ListStarredChanges, SubmittedTogether, SuggestChangeReviewers, TestSubmitType.Get, Votes.List

public interface RestReadView<R extends RestResource>
extends RestView<R>

RestView to read a resource without modification.

Method Summary

Modifier and Type	Method and Description
Object	apply(R resource) Process the view operation by reading from the resource.

Method Detail

apply

Object apply(R resource)
      throws AuthException,
             BadRequestException,
             ResourceConflictException,
             Exception

Process the view operation by reading from the resource.

Parameters:

resource - resource to read.

Returns:

result to return to the client. Use BinaryResult to avoid automatic conversion to JSON.

Throws:

AuthException - the client 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.

Exception - the implementation of the view failed. The exception will be logged and HTTP 500 Internal Server Error will be returned to the client.