com.google.gerrit.extensions.api.projects.ProjectApi 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.projects;
import com.google.gerrit.extensions.api.access.ProjectAccessInfo;
import com.google.gerrit.extensions.api.access.ProjectAccessInput;
import com.google.gerrit.extensions.api.config.AccessCheckInfo;
import com.google.gerrit.extensions.api.config.AccessCheckInput;
import com.google.gerrit.extensions.common.BatchLabelInput;
import com.google.gerrit.extensions.common.ChangeInfo;
import com.google.gerrit.extensions.common.LabelDefinitionInfo;
import com.google.gerrit.extensions.common.ProjectInfo;
import com.google.gerrit.extensions.common.SubmitRequirementInfo;
import com.google.gerrit.extensions.restapi.NotImplementedException;
import com.google.gerrit.extensions.restapi.RestApiException;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import java.util.Set;
public interface ProjectApi {
ProjectApi create() throws RestApiException;
ProjectApi create(ProjectInput in) throws RestApiException;
ProjectInfo get() throws RestApiException;
String description() throws RestApiException;
void description(DescriptionInput in) throws RestApiException;
ProjectAccessInfo access() throws RestApiException;
ProjectAccessInfo access(ProjectAccessInput p) throws RestApiException;
ChangeInfo accessChange(ProjectAccessInput p) throws RestApiException;
AccessCheckInfo checkAccess(AccessCheckInput in) throws RestApiException;
CheckProjectResultInfo check(CheckProjectInput in) throws RestApiException;
ConfigInfo config() throws RestApiException;
ConfigInfo config(ConfigInput in) throws RestApiException;
Map> commitsIn(Collection commits, Collection refs)
throws RestApiException;
ListRefsRequest branches();
ListRefsRequest tags();
void deleteBranches(DeleteBranchesInput in) throws RestApiException;
void deleteTags(DeleteTagsInput in) throws RestApiException;
abstract class ListRefsRequest {
protected int limit;
protected int start;
protected String substring;
protected String regex;
protected String nextPageToken;
public abstract List get() throws RestApiException;
public ListRefsRequest withLimit(int limit) {
this.limit = limit;
return this;
}
public ListRefsRequest withStart(int start) {
this.start = start;
return this;
}
public ListRefsRequest withNextPageToken(String token) {
this.nextPageToken = token;
return this;
}
public ListRefsRequest withSubstring(String substring) {
this.substring = substring;
return this;
}
public ListRefsRequest withRegex(String regex) {
this.regex = regex;
return this;
}
public int getLimit() {
return limit;
}
public int getStart() {
return start;
}
public String getNextPageToken() {
return nextPageToken;
}
public String getSubstring() {
return substring;
}
public String getRegex() {
return regex;
}
}
List children() throws RestApiException;
List children(boolean recursive) throws RestApiException;
List children(int limit) throws RestApiException;
ChildProjectApi child(String name) throws RestApiException;
/**
* Look up a branch by refname.
*
* Note: This method eagerly reads the branch. Methods that mutate the branch
* do not necessarily re-read the branch. 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 BranchApi} instances.
*
* @param ref branch name, with or without "refs/heads/" prefix.
* @throws RestApiException if a problem occurred reading the project.
* @return API for accessing the branch.
*/
BranchApi branch(String ref) throws RestApiException;
/**
* Look up a tag by refname.
*
*
*
* @param ref tag name, with or without "refs/tags/" prefix.
* @throws RestApiException if a problem occurred reading the project.
* @return API for accessing the tag.
*/
TagApi tag(String ref) throws RestApiException;
/**
* Lookup a commit by its {@code ObjectId} string.
*
* @param commit the {@code ObjectId} string.
* @return API for accessing the commit.
*/
CommitApi commit(String commit) throws RestApiException;
/**
* Lookup a dashboard by its name.
*
* @param name the name.
* @return API for accessing the dashboard.
*/
DashboardApi dashboard(String name) throws RestApiException;
/**
* Get the project's default dashboard.
*
* @return API for accessing the dashboard.
*/
DashboardApi defaultDashboard() throws RestApiException;
/**
* Set the project's default dashboard.
*
* @param name the dashboard to set as default.
*/
void defaultDashboard(String name) throws RestApiException;
/** Remove the project's default dashboard. */
void removeDefaultDashboard() throws RestApiException;
abstract class ListDashboardsRequest {
public abstract List get() throws RestApiException;
}
ListDashboardsRequest dashboards() throws RestApiException;
/** Get the name of the branch to which {@code HEAD} points. */
String head() throws RestApiException;
/**
* Set the project's {@code HEAD}.
*
* @param head the HEAD
*/
void head(String head) throws RestApiException;
/** Get the name of the project's parent. */
String parent() throws RestApiException;
/**
* Set the project's parent.
*
* @param parent the parent
*/
void parent(String parent) throws RestApiException;
/**
* Reindex the project and children in case {@code indexChildren} is specified.
*
* @param indexChildren decides if children should be indexed recursively
*/
void index(boolean indexChildren) throws RestApiException;
/** Reindexes all changes of the project. */
void indexChanges() throws RestApiException;
ListLabelsRequest labels() throws RestApiException;
abstract class ListLabelsRequest {
protected boolean inherited;
public abstract List get() throws RestApiException;
public ListLabelsRequest withInherited(boolean inherited) {
this.inherited = inherited;
return this;
}
}
LabelApi label(String labelName) throws RestApiException;
ListSubmitRequirementsRequest submitRequirements() throws RestApiException;
abstract class ListSubmitRequirementsRequest {
protected boolean inherited;
public abstract List get() throws RestApiException;
public ListSubmitRequirementsRequest withInherited(boolean inherited) {
this.inherited = inherited;
return this;
}
}
SubmitRequirementApi submitRequirement(String name) throws RestApiException;
/**
* Adds, updates and deletes label definitions in a batch.
*
* @param input input that describes additions, updates and deletions of label definitions
*/
void labels(BatchLabelInput input) throws RestApiException;
/**
* A default implementation which allows source compatibility when adding new methods to the
* interface.
*/
class NotImplemented implements ProjectApi {
@Override
public ProjectApi create() throws RestApiException {
throw new NotImplementedException();
}
@Override
public ProjectApi create(ProjectInput in) throws RestApiException {
throw new NotImplementedException();
}
@Override
public ProjectInfo get() throws RestApiException {
throw new NotImplementedException();
}
@Override
public String description() throws RestApiException {
throw new NotImplementedException();
}
@Override
public ProjectAccessInfo access() throws RestApiException {
throw new NotImplementedException();
}
@Override
public ProjectAccessInfo access(ProjectAccessInput p) throws RestApiException {
throw new NotImplementedException();
}
@Override
public ChangeInfo accessChange(ProjectAccessInput input) throws RestApiException {
throw new NotImplementedException();
}
@Override
public AccessCheckInfo checkAccess(AccessCheckInput in) throws RestApiException {
throw new NotImplementedException();
}
@Override
public CheckProjectResultInfo check(CheckProjectInput in) throws RestApiException {
throw new NotImplementedException();
}
@Override
public ConfigInfo config() throws RestApiException {
throw new NotImplementedException();
}
@Override
public ConfigInfo config(ConfigInput in) throws RestApiException {
throw new NotImplementedException();
}
@Override
public Map> commitsIn(Collection commits, Collection refs)
throws RestApiException {
throw new NotImplementedException();
}
@Override
public void description(DescriptionInput in) throws RestApiException {
throw new NotImplementedException();
}
@Override
public ListRefsRequest branches() {
throw new NotImplementedException();
}
@Override
public ListRefsRequest tags() {
throw new NotImplementedException();
}
@Override
public List children() throws RestApiException {
throw new NotImplementedException();
}
@Override
public List children(boolean recursive) throws RestApiException {
throw new NotImplementedException();
}
@Override
public List children(int limit) throws RestApiException {
throw new NotImplementedException();
}
@Override
public ChildProjectApi child(String name) throws RestApiException {
throw new NotImplementedException();
}
@Override
public BranchApi branch(String ref) throws RestApiException {
throw new NotImplementedException();
}
@Override
public TagApi tag(String ref) throws RestApiException {
throw new NotImplementedException();
}
@Override
public void deleteBranches(DeleteBranchesInput in) throws RestApiException {
throw new NotImplementedException();
}
@Override
public void deleteTags(DeleteTagsInput in) throws RestApiException {
throw new NotImplementedException();
}
@Override
public CommitApi commit(String commit) throws RestApiException {
throw new NotImplementedException();
}
@Override
public DashboardApi dashboard(String name) throws RestApiException {
throw new NotImplementedException();
}
@Override
public DashboardApi defaultDashboard() throws RestApiException {
throw new NotImplementedException();
}
@Override
public ListDashboardsRequest dashboards() throws RestApiException {
throw new NotImplementedException();
}
@Override
public void defaultDashboard(String name) throws RestApiException {
throw new NotImplementedException();
}
@Override
public void removeDefaultDashboard() throws RestApiException {
throw new NotImplementedException();
}
@Override
public String head() throws RestApiException {
throw new NotImplementedException();
}
@Override
public void head(String head) throws RestApiException {
throw new NotImplementedException();
}
@Override
public String parent() throws RestApiException {
throw new NotImplementedException();
}
@Override
public void parent(String parent) throws RestApiException {
throw new NotImplementedException();
}
@Override
public void index(boolean indexChildren) throws RestApiException {
throw new NotImplementedException();
}
@Override
public void indexChanges() throws RestApiException {
throw new NotImplementedException();
}
@Override
public ListLabelsRequest labels() throws RestApiException {
throw new NotImplementedException();
}
@Override
public ListSubmitRequirementsRequest submitRequirements() throws RestApiException {
throw new NotImplementedException();
}
@Override
public LabelApi label(String labelName) throws RestApiException {
throw new NotImplementedException();
}
@Override
public SubmitRequirementApi submitRequirement(String name) throws RestApiException {
throw new NotImplementedException();
}
@Override
public void labels(BatchLabelInput input) throws RestApiException {
throw new NotImplementedException();
}
}
}