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

Class ListChangeDrafts

java.lang.Object

com.google.gerrit.server.restapi.change.ListChangeDrafts

All Implemented Interfaces:

RestReadView<ChangeResource>, RestView<ChangeResource>

Direct Known Subclasses:

ListChangeComments

public class ListChangeDrafts
extends Object
implements RestReadView<ChangeResource>

Field Summary

Fields

Modifier and Type	Field	Description
protected ChangeData.Factory	changeDataFactory
protected com.google.inject.Provider<CommentJson>	commentJson
protected CommentsUtil	commentsUtil

Method Summary

Modifier and Type	Method	Description
Response<Map<String,List<CommentInfo>>>	apply(ChangeResource rsrc)	Process the view operation by reading from the resource.
List<CommentInfo>	getComments(ChangeResource rsrc)
protected boolean	includeAuthorInfo()
protected Iterable<Comment>	listComments(ChangeResource rsrc)
boolean	requireAuthentication()

Methods inherited from class java.lang.Object

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

Field Detail

changeDataFactory

protected final ChangeData.Factory changeDataFactory

commentJson

protected final com.google.inject.Provider<CommentJson> commentJson

commentsUtil

protected final CommentsUtil commentsUtil

Method Detail

listComments

protected Iterable<Comment> listComments(ChangeResource rsrc)

includeAuthorInfo

protected boolean includeAuthorInfo()

requireAuthentication

public boolean requireAuthentication()

apply

public Response<Map<String,List<CommentInfo>>> apply(ChangeResource rsrc)
                                                    throws AuthException,
                                                           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<ChangeResource>

Parameters:

rsrc - resource to read

Returns:

response to return to the client

Throws:

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

PermissionBackendException

getComments

public List<CommentInfo> getComments(ChangeResource rsrc)
                              throws AuthException,
                                     PermissionBackendException

Throws:

AuthException

PermissionBackendException