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

Class ChangeApi.NotImplemented

java.lang.Object

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

All Implemented Interfaces:

ChangeApi

Enclosing interface:

ChangeApi

public static class ChangeApi.NotImplemented
extends Object
implements ChangeApi

A default implementation which allows source compatibility when adding new methods to the interface.

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.gerrit.extensions.api.changes.ChangeApi

ChangeApi.CheckSubmitRequirementRequest, ChangeApi.CommentsRequest, ChangeApi.DraftsRequest, ChangeApi.NotImplemented, ChangeApi.SuggestedReviewersRequest

Constructor Summary

Constructors

Constructor	Description
NotImplemented()

Method Summary

Modifier and Type	Method	Description
void	abandon(AbandonInput in)
ReviewerResult	addReviewer(ReviewerInput in)
AccountInfo	addToAttentionSet(AttentionSetInput input)	Adds a user to the attention set.
ChangeInfo	applyPatch(ApplyPatchPatchSetInput in)
AttentionSetApi	attention(String id)	Manage the attention set.
ChangeInfo	check()
ChangeInfo	check(FixInput fix)
SubmitRequirementResultInfo	checkSubmitRequirement(SubmitRequirementInput input)	Returns the result of evaluating the SubmitRequirementInput input on the change.
ChangeApi.CheckSubmitRequirementRequest	checkSubmitRequirementRequest()
Map<String,List<CommentInfo>>	comments()	Deprecated.
List<CommentInfo>	commentsAsList()	Deprecated.
ChangeApi.CommentsRequest	commentsRequest()	Get a ChangeApi.CommentsRequest entity that can be used to retrieve published comments.
ChangeInfo	createMergePatchSet(MergePatchSetInput in)	Create a merge patch set for the change.
void	delete()	Deletes a change.
Map<String,List<CommentInfo>>	drafts()	Get all draft comments for the current user on a change.
List<CommentInfo>	draftsAsList()	Get all draft comments for the current user on a change as a list.
ChangeApi.DraftsRequest	draftsRequest()	Get a ChangeApi.DraftsRequest entity that can be used to retrieve draft comments.
ChangeEditApi	edit()	Provides access to an API regarding the change edit of this change.
ChangeInfo	get(EnumSet<ListChangesOption> options, com.google.common.collect.ImmutableListMultimap<String,String> pluginOptions)
com.google.common.collect.ImmutableMap<String,String>	getCustomKeyedValues()	Gets the custom keyed values on a change.
Set<String>	getHashtags()	Get hashtags on a change.
String	id()
IncludedInInfo	includedIn()
void	index()
ChangeMessageApi	message(String id)	Look up a change message of a change by its id.
List<ChangeMessageInfo>	messages()	Get all messages of a change with detailed account info.
ChangeInfoDifference	metaDiff(String oldMetaRevId, String newMetaRevId, EnumSet<ListChangesOption> options, com.google.common.collect.ImmutableListMultimap<String,String> pluginOptions)	Gets the diff between a change's metadata with the two given refs.
void	move(MoveInput in)
PureRevertInfo	pureRevert()	Check if this change is a pure revert of the change stored in revertOf.
PureRevertInfo	pureRevert(String claimedOriginal)	Check if this change is a pure revert of claimedOriginal (SHA1 in 40 digit hex).
void	rebase(RebaseInput in)	Rebase the current revision of a change.
Response<RebaseChainInfo>	rebaseChain(RebaseInput in)	Rebase the current revisions of a change's chain.
void	restore(RestoreInput in)
ChangeApi	revert(RevertInput in)	Create a new change that reverts this change.
RevertSubmissionInfo	revertSubmission(RevertInput in)
ReviewerApi	reviewer(String id)	Look up the reviewer of the change.
List<ReviewerInfo>	reviewers()	Retrieve reviewers (ReviewerState.REVIEWER and ReviewerState.CC) on the change.
RevisionApi	revision(String id)	Look up a revision of a change by commit SHA-1 or other supported revision string.
Map<String,List<RobotCommentInfo>>	robotComments()	Get all robot comments on a change.
void	setCustomKeyedValues(CustomKeyedValuesInput input)	Set custom keyed values on a change
void	setHashtags(HashtagsInput input)	Set hashtags on a change
void	setMessage(CommitMessageInput in)	Create a new patch set with a new commit message.
void	setPrivate(boolean value, String message)
void	setReadyForReview(String message)
void	setWorkInProgress(String message)
List<ChangeInfo>	submittedTogether()
SubmittedTogetherInfo	submittedTogether(EnumSet<SubmittedTogetherOption> options)
SubmittedTogetherInfo	submittedTogether(EnumSet<ListChangesOption> a, EnumSet<SubmittedTogetherOption> b)
ChangeApi.SuggestedReviewersRequest	suggestReviewers()
ChangeApi.SuggestedReviewersRequest	suggestReviewers(String query)
String	topic()
void	topic(String topic)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.gerrit.extensions.api.changes.ChangeApi

abandon, addReviewer, current, get, get, get, get, get, info, metaDiff, metaDiff, metaDiff, move, rebase, rebaseChain, restore, revert, revertSubmission, revision, setMessage, setPrivate, setReadyForReview, setWorkInProgress, suggestCcs

Constructor Details

NotImplemented

public NotImplemented()

Method Details

id

public String id()

Specified by:

id in interface ChangeApi

reviewer

public ReviewerApi reviewer(String id)
                     throws RestApiException

Description copied from interface: ChangeApi

Look up the reviewer of the change.

Specified by:

reviewer in interface ChangeApi

Parameters:

id - ID of the account, can be a string of the format "Full Name <[email protected]>", just the email address, a full name if it is unique, an account ID, a user name or 'self' for the calling user.

Returns:

API for accessing the reviewer.

Throws:

RestApiException - if id is not account ID or is a user that isn't known to be a reviewer for this change.

revision

public RevisionApi revision(String id)
                     throws RestApiException

Description copied from interface: ChangeApi

Look up a revision of a change by commit SHA-1 or other supported revision string.

Specified by:

revision in interface ChangeApi

Throws:

RestApiException

See Also:

• ChangeApi.current()

abandon

public void abandon(AbandonInput in)
             throws RestApiException

Specified by:

abandon in interface ChangeApi

Throws:

RestApiException

restore

public void restore(RestoreInput in)
             throws RestApiException

Specified by:

restore in interface ChangeApi

Throws:

RestApiException

move

public void move(MoveInput in)
          throws RestApiException

Specified by:

move in interface ChangeApi

Throws:

RestApiException

setPrivate

public void setPrivate(boolean value,
 String message)
                throws RestApiException

Specified by:

setPrivate in interface ChangeApi

Throws:

RestApiException

setWorkInProgress

public void setWorkInProgress(String message)
                       throws RestApiException

Specified by:

setWorkInProgress in interface ChangeApi

Throws:

RestApiException

setReadyForReview

public void setReadyForReview(String message)
                       throws RestApiException

Specified by:

setReadyForReview in interface ChangeApi

Throws:

RestApiException

revert

public ChangeApi revert(RevertInput in)
                 throws RestApiException

Description copied from interface: ChangeApi

Create a new change that reverts this change.

Specified by:

revert in interface ChangeApi

Throws:

RestApiException

See Also:

• Changes.id(int)

revertSubmission

public RevertSubmissionInfo revertSubmission(RevertInput in)
                                      throws RestApiException

Specified by:

revertSubmission in interface ChangeApi

Throws:

RestApiException

rebase

public void rebase(RebaseInput in)
            throws RestApiException

Description copied from interface: ChangeApi

Rebase the current revision of a change.

Specified by:

rebase in interface ChangeApi

Throws:

RestApiException

rebaseChain

public Response<RebaseChainInfo> rebaseChain(RebaseInput in)
                                      throws RestApiException

Description copied from interface: ChangeApi

Rebase the current revisions of a change's chain.

Specified by:

rebaseChain in interface ChangeApi

Returns:

a RebaseChainInfo contains the ChangeInfo data for the rebased the chain

Throws:

RestApiException

delete

public void delete()
            throws RestApiException

Description copied from interface: ChangeApi

Deletes a change.

Specified by:

delete in interface ChangeApi

Throws:

RestApiException

topic

public String topic()
             throws RestApiException

Specified by:

topic in interface ChangeApi

Throws:

RestApiException

topic

public void topic(String topic)
           throws RestApiException

Specified by:

topic in interface ChangeApi

Throws:

RestApiException

includedIn

public IncludedInInfo includedIn()
                          throws RestApiException

Specified by:

includedIn in interface ChangeApi

Throws:

RestApiException

addReviewer

public ReviewerResult addReviewer(ReviewerInput in)
                           throws RestApiException

Specified by:

addReviewer in interface ChangeApi

Throws:

RestApiException

suggestReviewers

public ChangeApi.SuggestedReviewersRequest suggestReviewers()
                                                     throws RestApiException

Specified by:

suggestReviewers in interface ChangeApi

Throws:

RestApiException

suggestReviewers

public ChangeApi.SuggestedReviewersRequest suggestReviewers(String query)
                                                     throws RestApiException

Specified by:

suggestReviewers in interface ChangeApi

Throws:

RestApiException

reviewers

public List<ReviewerInfo> reviewers()
                             throws RestApiException

Description copied from interface: ChangeApi

Retrieve reviewers (ReviewerState.REVIEWER and ReviewerState.CC) on the change.

Specified by:

reviewers in interface ChangeApi

Throws:

RestApiException

get

public ChangeInfo get(EnumSet<ListChangesOption> options,
 com.google.common.collect.ImmutableListMultimap<String,String> pluginOptions)
               throws RestApiException

Specified by:

get in interface ChangeApi

Throws:

RestApiException

metaDiff

public ChangeInfoDifference metaDiff(String oldMetaRevId,
 String newMetaRevId,
 EnumSet<ListChangesOption> options,
 com.google.common.collect.ImmutableListMultimap<String,String> pluginOptions)
                              throws RestApiException

Description copied from interface: ChangeApi

Gets the diff between a change's metadata with the two given refs.

Specified by:

metaDiff in interface ChangeApi

Parameters:

oldMetaRevId - the SHA-1 of the 'before' metadata diffed against newMetaRevId

newMetaRevId - the SHA-1 of the 'after' metadata diffed against oldMetaRevId

Throws:

RestApiException

setMessage

public void setMessage(CommitMessageInput in)
                throws RestApiException

Description copied from interface: ChangeApi

Create a new patch set with a new commit message.

Specified by:

setMessage in interface ChangeApi

Throws:

RestApiException

edit

public ChangeEditApi edit()
                   throws RestApiException

Description copied from interface: ChangeApi

Provides access to an API regarding the change edit of this change.

Specified by:

edit in interface ChangeApi

Returns:

a ChangeEditApi for the change edit of this change

Throws:

RestApiException - if the API isn't accessible

setHashtags

public void setHashtags(HashtagsInput input)
                 throws RestApiException

Description copied from interface: ChangeApi

Set hashtags on a change

Specified by:

setHashtags in interface ChangeApi

Throws:

RestApiException

getHashtags

public Set<String> getHashtags()
                        throws RestApiException

Description copied from interface: ChangeApi

Get hashtags on a change.

Specified by:

getHashtags in interface ChangeApi

Returns:

hashtags

Throws:

RestApiException

setCustomKeyedValues

public void setCustomKeyedValues(CustomKeyedValuesInput input)
                          throws RestApiException

Description copied from interface: ChangeApi

Set custom keyed values on a change

Specified by:

setCustomKeyedValues in interface ChangeApi

Throws:

RestApiException

getCustomKeyedValues

public com.google.common.collect.ImmutableMap<String,String> getCustomKeyedValues()
                                                                           throws RestApiException

Description copied from interface: ChangeApi

Gets the custom keyed values on a change.

Specified by:

getCustomKeyedValues in interface ChangeApi

Returns:

customKeyedValues

Throws:

RestApiException

attention

public AttentionSetApi attention(String id)
                          throws RestApiException

Description copied from interface: ChangeApi

Manage the attention set.

Specified by:

attention in interface ChangeApi

Parameters:

id - The account identifier.

Throws:

RestApiException

addToAttentionSet

public AccountInfo addToAttentionSet(AttentionSetInput input)
                              throws RestApiException

Description copied from interface: ChangeApi

Adds a user to the attention set.

Specified by:

addToAttentionSet in interface ChangeApi

Throws:

RestApiException

comments

@Deprecated
public Map<String,List<CommentInfo>> comments()
                                       throws RestApiException

Deprecated.

Description copied from interface: ChangeApi

Get all published comments on a change.

Specified by:

comments in interface ChangeApi

Returns:

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

Throws:

RestApiException

commentsAsList

@Deprecated
public List<CommentInfo> commentsAsList()
                                 throws RestApiException

Deprecated.

Description copied from interface: ChangeApi

Get all published comments on a change as a list.

Specified by:

commentsAsList in interface ChangeApi

Returns:

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

Throws:

RestApiException

commentsRequest

public ChangeApi.CommentsRequest commentsRequest()
                                          throws RestApiException

Description copied from interface: ChangeApi

Get a ChangeApi.CommentsRequest entity that can be used to retrieve published comments.

Specified by:

commentsRequest in interface ChangeApi

Returns:

A ChangeApi.CommentsRequest entity that can be used to retrieve the comments using the ChangeApi.CommentsRequest.get() or ChangeApi.CommentsRequest.getAsList().

Throws:

RestApiException

robotComments

public Map<String,List<RobotCommentInfo>> robotComments()
                                                 throws RestApiException

Description copied from interface: ChangeApi

Get all robot comments on a change.

Specified by:

robotComments in interface ChangeApi

Returns:

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

Throws:

RestApiException

drafts

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

Description copied from interface: ChangeApi

Get all draft comments for the current user on a change.

Specified by:

drafts in interface ChangeApi

Returns:

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

Throws:

RestApiException

draftsAsList

public List<CommentInfo> draftsAsList()
                               throws RestApiException

Description copied from interface: ChangeApi

Get all draft comments for the current user on a change as a list.

Specified by:

draftsAsList in interface ChangeApi

Returns:

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

Throws:

RestApiException

draftsRequest

public ChangeApi.DraftsRequest draftsRequest()
                                      throws RestApiException

Description copied from interface: ChangeApi

Get a ChangeApi.DraftsRequest entity that can be used to retrieve draft comments.

Specified by:

draftsRequest in interface ChangeApi

Returns:

A ChangeApi.DraftsRequest entity that can be used to retrieve the draft comments using ChangeApi.CommentsRequest.get() or ChangeApi.CommentsRequest.getAsList().

Throws:

RestApiException

check

public ChangeInfo check()
                 throws RestApiException

Specified by:

check in interface ChangeApi

Throws:

RestApiException

check

public ChangeInfo check(FixInput fix)
                 throws RestApiException

Specified by:

check in interface ChangeApi

Throws:

RestApiException

checkSubmitRequirementRequest

public ChangeApi.CheckSubmitRequirementRequest checkSubmitRequirementRequest()
                                                                      throws RestApiException

Specified by:

checkSubmitRequirementRequest in interface ChangeApi

Throws:

RestApiException

checkSubmitRequirement

public SubmitRequirementResultInfo checkSubmitRequirement(SubmitRequirementInput input)
                                                   throws RestApiException

Description copied from interface: ChangeApi

Returns the result of evaluating the SubmitRequirementInput input on the change.

Specified by:

checkSubmitRequirement in interface ChangeApi

Throws:

RestApiException

index

public void index()
           throws RestApiException

Specified by:

index in interface ChangeApi

Throws:

RestApiException

submittedTogether

public List<ChangeInfo> submittedTogether()
                                   throws RestApiException

Specified by:

submittedTogether in interface ChangeApi

Throws:

RestApiException

submittedTogether

public SubmittedTogetherInfo submittedTogether(EnumSet<SubmittedTogetherOption> options)
                                        throws RestApiException

Specified by:

submittedTogether in interface ChangeApi

Throws:

RestApiException

submittedTogether

public SubmittedTogetherInfo submittedTogether(EnumSet<ListChangesOption> a,
 EnumSet<SubmittedTogetherOption> b)
                                        throws RestApiException

Specified by:

submittedTogether in interface ChangeApi

Throws:

RestApiException

createMergePatchSet

public ChangeInfo createMergePatchSet(MergePatchSetInput in)
                               throws RestApiException

Description copied from interface: ChangeApi

Create a merge patch set for the change.

Specified by:

createMergePatchSet in interface ChangeApi

Throws:

RestApiException

applyPatch

public ChangeInfo applyPatch(ApplyPatchPatchSetInput in)
                      throws RestApiException

Specified by:

applyPatch in interface ChangeApi

Throws:

RestApiException

pureRevert

public PureRevertInfo pureRevert()
                          throws RestApiException

Description copied from interface: ChangeApi

Check if this change is a pure revert of the change stored in revertOf.

Specified by:

pureRevert in interface ChangeApi

Throws:

RestApiException

pureRevert

public PureRevertInfo pureRevert(String claimedOriginal)
                          throws RestApiException

Description copied from interface: ChangeApi

Check if this change is a pure revert of claimedOriginal (SHA1 in 40 digit hex).

Specified by:

pureRevert in interface ChangeApi

Throws:

RestApiException

messages

public List<ChangeMessageInfo> messages()
                                 throws RestApiException

Description copied from interface: ChangeApi

Get all messages of a change with detailed account info.

Specified by:

messages in interface ChangeApi

Returns:

a list of messages sorted by their creation time.

Throws:

RestApiException

message

public ChangeMessageApi message(String id)
                         throws RestApiException

Description copied from interface: ChangeApi

Look up a change message of a change by its id.

Specified by:

message in interface ChangeApi

Parameters:

id - the id of the change message. In NoteDb, this id is the ObjectId of a commit on the change meta branch.

Returns:

API for accessing a change message.

Throws:

RestApiException - if the id is invalid.