Package com.google.gerrit.extensions.api.changes

Class ChangeApi.CommentsRequest

java.lang.Object

com.google.gerrit.extensions.api.changes.ChangeApi.CommentsRequest

Direct Known Subclasses:

ChangeApi.DraftsRequest

Enclosing interface:

ChangeApi

public abstract static class ChangeApi.CommentsRequest
extends Object

Constructor Summary

Constructors

Constructor	Description
CommentsRequest()

Method Summary

Modifier and Type	Method	Description
ChangeApi.CommentsRequest	contextPadding(int contextPadding)
abstract Map<String,List<CommentInfo>>	get()	Get all published comments on a change.
abstract List<CommentInfo>	getAsList()	Get all published comments on a change as a list.
boolean	getContext()
int	getContextPadding()
ChangeApi.CommentsRequest	withContext()
ChangeApi.CommentsRequest	withContext(boolean enableContext)

Methods inherited from class java.lang.Object

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

Constructor Detail

CommentsRequest

public CommentsRequest()

Method Detail

get

public abstract Map<String,List<CommentInfo>> get()
                                                 throws RestApiException

Get all published comments on a change.

Returns:

comments in a map keyed by path; comments have the revision field set to indicate their patch set.

Throws:

RestApiException

getAsList

public abstract List<CommentInfo> getAsList()
                                     throws RestApiException

Get all published comments on a change as a list.

Returns:

comments as a list; comments have the revision field set to indicate their patch set.

Throws:

RestApiException

withContext

public ChangeApi.CommentsRequest withContext(boolean enableContext)

contextPadding

public ChangeApi.CommentsRequest contextPadding(int contextPadding)

withContext

public ChangeApi.CommentsRequest withContext()

getContext

public boolean getContext()

getContextPadding

public int getContextPadding()