Package com.google.gerrit.extensions.api.projects

Class ProjectApi.NotImplemented

java.lang.Object

com.google.gerrit.extensions.api.projects.ProjectApi.NotImplemented

All Implemented Interfaces:

ProjectApi

Enclosing interface:

ProjectApi

public static class ProjectApi.NotImplemented
extends Object
implements ProjectApi

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.projects.ProjectApi

ProjectApi.ListDashboardsRequest, ProjectApi.ListLabelsRequest, ProjectApi.ListRefsRequest<T extends RefInfo>, ProjectApi.ListSubmitRequirementsRequest, ProjectApi.NotImplemented

Constructor Summary

Constructors

Constructor	Description
NotImplemented()

Method Summary

Modifier and Type	Method	Description
ProjectAccessInfo	access()
ProjectAccessInfo	access(ProjectAccessInput p)
ChangeInfo	accessChange(ProjectAccessInput input)
BranchApi	branch(String ref)	Look up a branch by refname.
ProjectApi.ListRefsRequest<BranchInfo>	branches()
CheckProjectResultInfo	check(CheckProjectInput in)
AccessCheckInfo	checkAccess(AccessCheckInput in)
ChildProjectApi	child(String name)
List<ProjectInfo>	children()
List<ProjectInfo>	children(boolean recursive)
List<ProjectInfo>	children(int limit)
CommitApi	commit(String commit)	Lookup a commit by its ObjectId string.
Map<String,Set<String>>	commitsIn(Collection<String> commits, Collection<String> refs)
ConfigInfo	config()
ConfigInfo	config(ConfigInput in)
ChangeInfo	configReview(ConfigInput in)
ProjectApi	create()
ProjectApi	create(ProjectInput in)
DashboardApi	dashboard(String name)	Lookup a dashboard by its name.
ProjectApi.ListDashboardsRequest	dashboards()
DashboardApi	defaultDashboard()	Get the project's default dashboard.
void	defaultDashboard(String name)	Set the project's default dashboard.
void	deleteBranches(DeleteBranchesInput in)
void	deleteTags(DeleteTagsInput in)
String	description()
void	description(DescriptionInput in)
ProjectInfo	get()
String	head()	Get the name of the branch to which HEAD points.
void	head(String head)	Set the project's HEAD.
void	index(boolean indexChildren)	Reindex the project and children in case indexChildren is specified.
void	indexChanges()	Reindexes all changes of the project.
LabelApi	label(String labelName)
ProjectApi.ListLabelsRequest	labels()
void	labels(BatchLabelInput input)	Adds, updates and deletes label definitions in a batch.
ChangeInfo	labelsReview(BatchLabelInput input)	Same as ProjectApi.labels(BatchLabelInput), but creates a change with required updates.
String	parent()	Get the name of the project's parent.
void	parent(String parent)	Set the project's parent.
void	removeDefaultDashboard()	Remove the project's default dashboard.
SubmitRequirementApi	submitRequirement(String name)
ProjectApi.ListSubmitRequirementsRequest	submitRequirements()
void	submitRequirements(BatchSubmitRequirementInput input)	Adds, updates and deletes submit requirements definitions in a batch.
ChangeInfo	submitRequirementsReview(BatchSubmitRequirementInput input)	Creates a change with required submit requirements updates.
TagApi	tag(String ref)	Look up a tag by refname.
ProjectApi.ListRefsRequest<TagInfo>	tags()

Methods inherited from class java.lang.Object

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

Constructor Details

NotImplemented

public NotImplemented()

Method Details

create

public ProjectApi create()
                  throws RestApiException

Specified by:

create in interface ProjectApi

Throws:

RestApiException

create

public ProjectApi create(ProjectInput in)
                  throws RestApiException

Specified by:

create in interface ProjectApi

Throws:

RestApiException

get

public ProjectInfo get()
                throws RestApiException

Specified by:

get in interface ProjectApi

Throws:

RestApiException

description

public String description()
                   throws RestApiException

Specified by:

description in interface ProjectApi

Throws:

RestApiException

access

public ProjectAccessInfo access()
                         throws RestApiException

Specified by:

access in interface ProjectApi

Throws:

RestApiException

access

public ProjectAccessInfo access(ProjectAccessInput p)
                         throws RestApiException

Specified by:

access in interface ProjectApi

Throws:

RestApiException

accessChange

public ChangeInfo accessChange(ProjectAccessInput input)
                        throws RestApiException

Specified by:

accessChange in interface ProjectApi

Throws:

RestApiException

checkAccess

public AccessCheckInfo checkAccess(AccessCheckInput in)
                            throws RestApiException

Specified by:

checkAccess in interface ProjectApi

Throws:

RestApiException

check

public CheckProjectResultInfo check(CheckProjectInput in)
                             throws RestApiException

Specified by:

check in interface ProjectApi

Throws:

RestApiException

config

public ConfigInfo config()
                  throws RestApiException

Specified by:

config in interface ProjectApi

Throws:

RestApiException

config

public ConfigInfo config(ConfigInput in)
                  throws RestApiException

Specified by:

config in interface ProjectApi

Throws:

RestApiException

configReview

public ChangeInfo configReview(ConfigInput in)
                        throws RestApiException

Specified by:

configReview in interface ProjectApi

Throws:

RestApiException

commitsIn

public Map<String,Set<String>> commitsIn(Collection<String> commits,
 Collection<String> refs)
                                  throws RestApiException

Specified by:

commitsIn in interface ProjectApi

Throws:

RestApiException

description

public void description(DescriptionInput in)
                 throws RestApiException

Specified by:

description in interface ProjectApi

Throws:

RestApiException

branches

public ProjectApi.ListRefsRequest<BranchInfo> branches()

Specified by:

branches in interface ProjectApi

tags

public ProjectApi.ListRefsRequest<TagInfo> tags()

Specified by:

tags in interface ProjectApi

children

public List<ProjectInfo> children()
                           throws RestApiException

Specified by:

children in interface ProjectApi

Throws:

RestApiException

children

public List<ProjectInfo> children(boolean recursive)
                           throws RestApiException

Specified by:

children in interface ProjectApi

Throws:

RestApiException

children

public List<ProjectInfo> children(int limit)
                           throws RestApiException

Specified by:

children in interface ProjectApi

Throws:

RestApiException

child

public ChildProjectApi child(String name)
                      throws RestApiException

Specified by:

child in interface ProjectApi

Throws:

RestApiException

branch

public BranchApi branch(String ref)
                 throws RestApiException

Description copied from interface: ProjectApi

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 BranchApi instances.

Specified by:

branch in interface ProjectApi

Parameters:

ref - branch name, with or without "refs/heads/" prefix.

Returns:

API for accessing the branch.

Throws:

RestApiException - if a problem occurred reading the project.

tag

public TagApi tag(String ref)
           throws RestApiException

Description copied from interface: ProjectApi

Look up a tag by refname.

Specified by:

tag in interface ProjectApi

Parameters:

ref - tag name, with or without "refs/tags/" prefix.

Returns:

API for accessing the tag.

Throws:

RestApiException - if a problem occurred reading the project.

deleteBranches

public void deleteBranches(DeleteBranchesInput in)
                    throws RestApiException

Specified by:

deleteBranches in interface ProjectApi

Throws:

RestApiException

deleteTags

public void deleteTags(DeleteTagsInput in)
                throws RestApiException

Specified by:

deleteTags in interface ProjectApi

Throws:

RestApiException

commit

public CommitApi commit(String commit)
                 throws RestApiException

Description copied from interface: ProjectApi

Lookup a commit by its ObjectId string.

Specified by:

commit in interface ProjectApi

Parameters:

commit - the ObjectId string.

Returns:

API for accessing the commit.

Throws:

RestApiException

dashboard

public DashboardApi dashboard(String name)
                       throws RestApiException

Description copied from interface: ProjectApi

Lookup a dashboard by its name.

Specified by:

dashboard in interface ProjectApi

Parameters:

name - the name.

Returns:

API for accessing the dashboard.

Throws:

RestApiException

defaultDashboard

public DashboardApi defaultDashboard()
                              throws RestApiException

Description copied from interface: ProjectApi

Get the project's default dashboard.

Specified by:

defaultDashboard in interface ProjectApi

Returns:

API for accessing the dashboard.

Throws:

RestApiException

dashboards

public ProjectApi.ListDashboardsRequest dashboards()
                                            throws RestApiException

Specified by:

dashboards in interface ProjectApi

Throws:

RestApiException

defaultDashboard

public void defaultDashboard(String name)
                      throws RestApiException

Description copied from interface: ProjectApi

Set the project's default dashboard.

Specified by:

defaultDashboard in interface ProjectApi

Parameters:

name - the dashboard to set as default.

Throws:

RestApiException

removeDefaultDashboard

public void removeDefaultDashboard()
                            throws RestApiException

Description copied from interface: ProjectApi

Remove the project's default dashboard.

Specified by:

removeDefaultDashboard in interface ProjectApi

Throws:

RestApiException

head

public String head()
            throws RestApiException

Description copied from interface: ProjectApi

Get the name of the branch to which HEAD points.

Specified by:

head in interface ProjectApi

Throws:

RestApiException

head

public void head(String head)
          throws RestApiException

Description copied from interface: ProjectApi

Set the project's HEAD.

Specified by:

head in interface ProjectApi

Parameters:

head - the HEAD

Throws:

RestApiException

parent

public String parent()
              throws RestApiException

Description copied from interface: ProjectApi

Get the name of the project's parent.

Specified by:

parent in interface ProjectApi

Throws:

RestApiException

parent

public void parent(String parent)
            throws RestApiException

Description copied from interface: ProjectApi

Set the project's parent.

Specified by:

parent in interface ProjectApi

Parameters:

parent - the parent

Throws:

RestApiException

index

public void index(boolean indexChildren)
           throws RestApiException

Description copied from interface: ProjectApi

Reindex the project and children in case indexChildren is specified.

Specified by:

index in interface ProjectApi

Parameters:

indexChildren - decides if children should be indexed recursively

Throws:

RestApiException

indexChanges

public void indexChanges()
                  throws RestApiException

Description copied from interface: ProjectApi

Reindexes all changes of the project.

Specified by:

indexChanges in interface ProjectApi

Throws:

RestApiException

labels

public ProjectApi.ListLabelsRequest labels()
                                    throws RestApiException

Specified by:

labels in interface ProjectApi

Throws:

RestApiException

submitRequirements

public ProjectApi.ListSubmitRequirementsRequest submitRequirements()
                                                            throws RestApiException

Specified by:

submitRequirements in interface ProjectApi

Throws:

RestApiException

label

public LabelApi label(String labelName)
               throws RestApiException

Specified by:

label in interface ProjectApi

Throws:

RestApiException

submitRequirement

public SubmitRequirementApi submitRequirement(String name)
                                       throws RestApiException

Specified by:

submitRequirement in interface ProjectApi

Throws:

RestApiException

labels

public void labels(BatchLabelInput input)
            throws RestApiException

Description copied from interface: ProjectApi

Adds, updates and deletes label definitions in a batch.

Specified by:

labels in interface ProjectApi

Parameters:

input - input that describes additions, updates and deletions of label definitions

Throws:

RestApiException

labelsReview

public ChangeInfo labelsReview(BatchLabelInput input)
                        throws RestApiException

Description copied from interface: ProjectApi

Same as ProjectApi.labels(BatchLabelInput), but creates a change with required updates.

Specified by:

labelsReview in interface ProjectApi

Throws:

RestApiException

submitRequirements

public void submitRequirements(BatchSubmitRequirementInput input)
                        throws RestApiException

Description copied from interface: ProjectApi

Adds, updates and deletes submit requirements definitions in a batch.

Specified by:

submitRequirements in interface ProjectApi

Parameters:

input - input that describes additions, updates and deletions of submit requirements

Throws:

RestApiException

submitRequirementsReview

public ChangeInfo submitRequirementsReview(BatchSubmitRequirementInput input)
                                    throws RestApiException

Description copied from interface: ProjectApi

Creates a change with required submit requirements updates.

See ProjectApi.submitRequirements(BatchSubmitRequirementInput) for details

Specified by:

submitRequirementsReview in interface ProjectApi

Throws:

RestApiException