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

Class ListChangeComments

java.lang.Object

com.google.gerrit.server.restapi.change.ListChangeComments

All Implemented Interfaces:

RestReadView<ChangeResource>, RestView<ChangeResource>

public class ListChangeComments
extends Object
implements RestReadView<ChangeResource>

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)
void	setContext(boolean context)	Optional parameter.
void	setContextPadding(int contextPadding)	Optional parameter.

Methods inherited from class java.lang.Object

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

Method Detail

setContext

public void setContext(boolean context)

Optional parameter. If set, the contextLines field of the ContextLineInfo of the response will contain the lines of the source file where the comment was written.

Parameters:

context - If true, comment context will be attached to the response

setContextPadding

public void setContextPadding(int contextPadding)

Optional parameter. Works only if includeContext is set to true. If contextPadding is set, the context lines in the response will be padded with contextPadding extra lines before and after the comment range.

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 PermissionBackendException

Throws:

PermissionBackendException