com.google.gerrit.extensions.api.changes.ChangeApi Maven / Gradle / Ivy
// Copyright (C) 2013 The Android Open Source Project
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package com.google.gerrit.extensions.api.changes;
import com.google.common.collect.Sets;
import com.google.gerrit.common.Nullable;
import com.google.gerrit.extensions.client.ListChangesOption;
import com.google.gerrit.extensions.common.AccountInfo;
import com.google.gerrit.extensions.common.ChangeInfo;
import com.google.gerrit.extensions.common.ChangeMessageInfo;
import com.google.gerrit.extensions.common.CommentInfo;
import com.google.gerrit.extensions.common.CommitMessageInput;
import com.google.gerrit.extensions.common.EditInfo;
import com.google.gerrit.extensions.common.MergePatchSetInput;
import com.google.gerrit.extensions.common.PureRevertInfo;
import com.google.gerrit.extensions.common.RobotCommentInfo;
import com.google.gerrit.extensions.common.SuggestedReviewerInfo;
import com.google.gerrit.extensions.restapi.NotImplementedException;
import com.google.gerrit.extensions.restapi.RestApiException;
import java.util.Arrays;
import java.util.EnumSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
public interface ChangeApi {
String id();
/**
* Look up the current revision for the change.
*
* Note: This method eagerly reads the revision. Methods that mutate the
* revision do not necessarily re-read the revision. Therefore, calling a getter method on an
* instance after calling a mutation method on that same instance is not guaranteed to reflect the
* mutation. It is not recommended to store references to {@code RevisionApi} instances.
*
* @return API for accessing the revision.
* @throws RestApiException if an error occurred.
*/
RevisionApi current() throws RestApiException;
/**
* Look up a revision of a change by number.
*
* @see #current()
*/
RevisionApi revision(int id) throws RestApiException;
/**
* Look up a revision of a change by commit SHA-1.
*
* @see #current()
*/
RevisionApi revision(String id) throws RestApiException;
/**
* Look up the reviewer of the change.
*
*
*
* @param 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.
* @return 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.
*/
ReviewerApi reviewer(String id) throws RestApiException;
void abandon() throws RestApiException;
void abandon(AbandonInput in) throws RestApiException;
void restore() throws RestApiException;
void restore(RestoreInput in) throws RestApiException;
void move(String destination) throws RestApiException;
void move(MoveInput in) throws RestApiException;
void setPrivate(boolean value, @Nullable String message) throws RestApiException;
void setWorkInProgress(String message) throws RestApiException;
void setReadyForReview(String message) throws RestApiException;
default void setWorkInProgress() throws RestApiException {
setWorkInProgress(null);
}
default void setReadyForReview() throws RestApiException {
setReadyForReview(null);
}
/**
* Ignore or un-ignore this change.
*
* @param ignore ignore the change if true
*/
void ignore(boolean ignore) throws RestApiException;
/**
* Check if this change is ignored.
*
* @return true if the change is ignored
*/
boolean ignored() throws RestApiException;
/**
* Mark this change as reviewed/unreviewed.
*
* @param reviewed flag to decide if this change should be marked as reviewed ({@code true}) or
* unreviewed ({@code false})
*/
void markAsReviewed(boolean reviewed) throws RestApiException;
/**
* Create a new change that reverts this change.
*
* @see Changes#id(int)
*/
ChangeApi revert() throws RestApiException;
/**
* Create a new change that reverts this change.
*
* @see Changes#id(int)
*/
ChangeApi revert(RevertInput in) throws RestApiException;
/** Create a merge patch set for the change. */
ChangeInfo createMergePatchSet(MergePatchSetInput in) throws RestApiException;
List submittedTogether() throws RestApiException;
SubmittedTogetherInfo submittedTogether(EnumSet options)
throws RestApiException;
SubmittedTogetherInfo submittedTogether(
EnumSet listOptions, EnumSet submitOptions)
throws RestApiException;
/** Publishes a draft change. */
@Deprecated
void publish() throws RestApiException;
/** Rebase the current revision of a change using default options. */
void rebase() throws RestApiException;
/** Rebase the current revision of a change. */
void rebase(RebaseInput in) throws RestApiException;
/** Deletes a change. */
void delete() throws RestApiException;
String topic() throws RestApiException;
void topic(String topic) throws RestApiException;
IncludedInInfo includedIn() throws RestApiException;
AddReviewerResult addReviewer(AddReviewerInput in) throws RestApiException;
AddReviewerResult addReviewer(String in) throws RestApiException;
SuggestedReviewersRequest suggestReviewers() throws RestApiException;
SuggestedReviewersRequest suggestReviewers(String query) throws RestApiException;
ChangeInfo get(EnumSet options) throws RestApiException;
default ChangeInfo get(Iterable options) throws RestApiException {
return get(Sets.newEnumSet(options, ListChangesOption.class));
}
default ChangeInfo get(ListChangesOption... options) throws RestApiException {
return get(Arrays.asList(options));
}
/**
* {@link #get(ListChangesOption...)} with all options included, except for the following.
*
*
* - {@code CHECK} is omitted, to skip consistency checks.
*
- {@code SKIP_MERGEABLE} is omitted, so the {@code mergeable} bit is set.
*
*/
ChangeInfo get() throws RestApiException;
/** {@link #get(ListChangesOption...)} with no options included. */
ChangeInfo info() throws RestApiException;
/**
* Retrieve change edit when exists.
*
* @deprecated Replaced by {@link ChangeApi#edit()} in combination with {@link
* ChangeEditApi#get()}.
*/
@Deprecated
EditInfo getEdit() throws RestApiException;
/**
* Provides access to an API regarding the change edit of this change.
*
* @return a {@code ChangeEditApi} for the change edit of this change
* @throws RestApiException if the API isn't accessible
*/
ChangeEditApi edit() throws RestApiException;
/** Create a new patch set with a new commit message. */
void setMessage(String message) throws RestApiException;
/** Create a new patch set with a new commit message. */
void setMessage(CommitMessageInput in) throws RestApiException;
/** Set hashtags on a change */
void setHashtags(HashtagsInput input) throws RestApiException;
/**
* Get hashtags on a change.
*
* @return hashtags
* @throws RestApiException
*/
Set getHashtags() throws RestApiException;
/** Set the assignee of a change. */
AccountInfo setAssignee(AssigneeInput input) throws RestApiException;
/** Get the assignee of a change. */
AccountInfo getAssignee() throws RestApiException;
/** Get all past assignees. */
List getPastAssignees() throws RestApiException;
/**
* Delete the assignee of a change.
*
* @return the assignee that was deleted, or null if there was no assignee.
*/
AccountInfo deleteAssignee() throws RestApiException;
/**
* Get all published comments on a change.
*
* @return comments in a map keyed by path; comments have the {@code revision} field set to
* indicate their patch set.
* @throws RestApiException
*/
Map> comments() throws RestApiException;
/**
* Get all robot comments on a change.
*
* @return robot comments in a map keyed by path; robot comments have the {@code revision} field
* set to indicate their patch set.
* @throws RestApiException
*/
Map> robotComments() throws RestApiException;
/**
* Get all draft comments for the current user on a change.
*
* @return drafts in a map keyed by path; comments have the {@code revision} field set to indicate
* their patch set.
* @throws RestApiException
*/
Map> drafts() throws RestApiException;
ChangeInfo check() throws RestApiException;
ChangeInfo check(FixInput fix) throws RestApiException;
void index() throws RestApiException;
/** Check if this change is a pure revert of the change stored in revertOf. */
PureRevertInfo pureRevert() throws RestApiException;
/** Check if this change is a pure revert of claimedOriginal (SHA1 in 40 digit hex). */
PureRevertInfo pureRevert(String claimedOriginal) throws RestApiException;
/**
* Get all messages of a change with detailed account info.
*
* @return a list of messages sorted by their creation time.
* @throws RestApiException
*/
List messages() throws RestApiException;
/**
* Look up a change message of a change by its id.
*
* @param id the id of the change message. Note that in NoteDb, this id is the {@code ObjectId} of
* a commit on the change meta branch. In ReviewDb, it's a UUID generated randomly. That means
* a change message id could be different between NoteDb and ReviewDb.
* @return API for accessing a change message.
* @throws RestApiException if the id is invalid.
*/
ChangeMessageApi message(String id) throws RestApiException;
abstract class SuggestedReviewersRequest {
private String query;
private int limit;
public abstract List get() throws RestApiException;
public SuggestedReviewersRequest withQuery(String query) {
this.query = query;
return this;
}
public SuggestedReviewersRequest withLimit(int limit) {
this.limit = limit;
return this;
}
public String getQuery() {
return query;
}
public int getLimit() {
return limit;
}
}
/**
* A default implementation which allows source compatibility when adding new methods to the
* interface.
*/
class NotImplemented implements ChangeApi {
@Override
public String id() {
throw new NotImplementedException();
}
@Override
public RevisionApi current() throws RestApiException {
throw new NotImplementedException();
}
@Override
public RevisionApi revision(int id) throws RestApiException {
throw new NotImplementedException();
}
@Override
public ReviewerApi reviewer(String id) throws RestApiException {
throw new NotImplementedException();
}
@Override
public RevisionApi revision(String id) throws RestApiException {
throw new NotImplementedException();
}
@Override
public void abandon() throws RestApiException {
throw new NotImplementedException();
}
@Override
public void abandon(AbandonInput in) throws RestApiException {
throw new NotImplementedException();
}
@Override
public void restore() throws RestApiException {
throw new NotImplementedException();
}
@Override
public void restore(RestoreInput in) throws RestApiException {
throw new NotImplementedException();
}
@Override
public void move(String destination) throws RestApiException {
throw new NotImplementedException();
}
@Override
public void move(MoveInput in) throws RestApiException {
throw new NotImplementedException();
}
@Override
public void setPrivate(boolean value, @Nullable String message) throws RestApiException {
throw new NotImplementedException();
}
@Override
public void setWorkInProgress(String message) throws RestApiException {
throw new NotImplementedException();
}
@Override
public void setReadyForReview(String message) throws RestApiException {
throw new NotImplementedException();
}
@Override
public ChangeApi revert() throws RestApiException {
throw new NotImplementedException();
}
@Override
public ChangeApi revert(RevertInput in) throws RestApiException {
throw new NotImplementedException();
}
@Override
public void publish() throws RestApiException {
throw new NotImplementedException();
}
@Deprecated
@Override
public void rebase() throws RestApiException {
throw new NotImplementedException();
}
@Override
public void rebase(RebaseInput in) throws RestApiException {
throw new NotImplementedException();
}
@Override
public void delete() throws RestApiException {
throw new NotImplementedException();
}
@Override
public String topic() throws RestApiException {
throw new NotImplementedException();
}
@Override
public void topic(String topic) throws RestApiException {
throw new NotImplementedException();
}
@Override
public IncludedInInfo includedIn() throws RestApiException {
throw new NotImplementedException();
}
@Override
public AddReviewerResult addReviewer(AddReviewerInput in) throws RestApiException {
throw new NotImplementedException();
}
@Override
public AddReviewerResult addReviewer(String in) throws RestApiException {
throw new NotImplementedException();
}
@Override
public SuggestedReviewersRequest suggestReviewers() throws RestApiException {
throw new NotImplementedException();
}
@Override
public SuggestedReviewersRequest suggestReviewers(String query) throws RestApiException {
throw new NotImplementedException();
}
@Override
public ChangeInfo get(EnumSet options) throws RestApiException {
throw new NotImplementedException();
}
@Override
public ChangeInfo get() throws RestApiException {
throw new NotImplementedException();
}
@Override
public ChangeInfo info() throws RestApiException {
throw new NotImplementedException();
}
@Override
public void setMessage(String message) throws RestApiException {
throw new NotImplementedException();
}
@Override
public void setMessage(CommitMessageInput in) throws RestApiException {
throw new NotImplementedException();
}
@Override
public EditInfo getEdit() throws RestApiException {
throw new NotImplementedException();
}
@Override
public ChangeEditApi edit() throws RestApiException {
throw new NotImplementedException();
}
@Override
public void setHashtags(HashtagsInput input) throws RestApiException {
throw new NotImplementedException();
}
@Override
public Set getHashtags() throws RestApiException {
throw new NotImplementedException();
}
@Override
public AccountInfo setAssignee(AssigneeInput input) throws RestApiException {
throw new NotImplementedException();
}
@Override
public AccountInfo getAssignee() throws RestApiException {
throw new NotImplementedException();
}
@Override
public List getPastAssignees() throws RestApiException {
throw new NotImplementedException();
}
@Override
public AccountInfo deleteAssignee() throws RestApiException {
throw new NotImplementedException();
}
@Override
public Map> comments() throws RestApiException {
throw new NotImplementedException();
}
@Override
public Map> robotComments() throws RestApiException {
throw new NotImplementedException();
}
@Override
public Map> drafts() throws RestApiException {
throw new NotImplementedException();
}
@Override
public ChangeInfo check() throws RestApiException {
throw new NotImplementedException();
}
@Override
public ChangeInfo check(FixInput fix) throws RestApiException {
throw new NotImplementedException();
}
@Override
public void index() throws RestApiException {
throw new NotImplementedException();
}
@Override
public List submittedTogether() throws RestApiException {
throw new NotImplementedException();
}
@Override
public SubmittedTogetherInfo submittedTogether(EnumSet options)
throws RestApiException {
throw new NotImplementedException();
}
@Override
public SubmittedTogetherInfo submittedTogether(
EnumSet a, EnumSet b) throws RestApiException {
throw new NotImplementedException();
}
@Override
public ChangeInfo createMergePatchSet(MergePatchSetInput in) throws RestApiException {
throw new NotImplementedException();
}
@Override
public void ignore(boolean ignore) throws RestApiException {
throw new NotImplementedException();
}
@Override
public boolean ignored() throws RestApiException {
throw new NotImplementedException();
}
@Override
public void markAsReviewed(boolean reviewed) throws RestApiException {
throw new NotImplementedException();
}
@Override
public PureRevertInfo pureRevert() throws RestApiException {
throw new NotImplementedException();
}
@Override
public PureRevertInfo pureRevert(String claimedOriginal) throws RestApiException {
throw new NotImplementedException();
}
@Override
public List messages() throws RestApiException {
throw new NotImplementedException();
}
@Override
public ChangeMessageApi message(String id) throws RestApiException {
throw new NotImplementedException();
}
}
}