Package com.google.gerrit.server.api.projects

Class ProjectApiImpl

java.lang.Object

com.google.gerrit.server.api.projects.ProjectApiImpl

All Implemented Interfaces:

ProjectApi

public class ProjectApiImpl
extends Object
implements ProjectApi

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.gerrit.extensions.api.projects.ProjectApi

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

Method Summary

Modifier and Type	Method	Description
ProjectAccessInfo	access()
ProjectAccessInfo	access(ProjectAccessInput p)
ChangeInfo	accessChange(ProjectAccessInput p)
BranchApi	branch(String ref)	Look up a branch by refname.
ProjectApi.ListRefsRequest<BranchInfo>	branches()
AccessCheckInfo	checkAccess(AccessCheckInput in)
ChildProjectApi	child(String name)
List<ProjectInfo>	children()
List<ProjectInfo>	children(boolean recursive)
CommitApi	commit(String commit)	Lookup a commit by its ObjectId string.
ConfigInfo	config()
ConfigInfo	config(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	removeDefaultDashboard()	Remove the project's default dashboard.
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

Method Detail

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

checkAccess

public AccessCheckInfo checkAccess(AccessCheckInput in)
                            throws RestApiException

Specified by:

checkAccess 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 p)
                        throws RestApiException

Specified by:

accessChange in interface ProjectApi

Throws:

RestApiException

description

public void description(DescriptionInput in)
                 throws RestApiException

Specified by:

description 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

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

child

public ChildProjectApi child(String name)
                      throws RestApiException

Specified by:

child in interface ProjectApi

Throws:

RestApiException

branch

public BranchApi branch(String ref)
                 throws ResourceNotFoundException

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:

ResourceNotFoundException

tag

public TagApi tag(String ref)
           throws ResourceNotFoundException

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:

ResourceNotFoundException

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

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

dashboards

public ProjectApi.ListDashboardsRequest dashboards()
                                            throws RestApiException

Specified by:

dashboards 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