com.atlassian.stash.project.ProjectSupplier |
Known Indirect Subclasses
|
Class Overview
Allows retrieving projects
by their ID
or key
.
This is a simplification of the ProjectService
, intended to be used in cases where a component needs to
be able to look up projects but doesn't need the full service functionality. Using this interface instead makes
such components easier to test.
Plugin developers: Plugins cannot autowire their components when importing both ProjectSupplier
and
ProjectService
. In general, if a plugin needs ProjectService
methods, it should only
use the ProjectService
. This interface should be used when a plugin only needs to retrieve projects.
Public Methods
@Nullable
public
Project
getById
(int id)
Parameters
id
| the ID of the project to retrieve |
Returns
- the project instance or
null
if no such project exists
@Nullable
public
Project
getByKey
(String key)
Parameters
key
| the key of the project to retrieve |
Returns
- the keyed project, or
null
if the key does not match an existing project
@Nullable
public
Project
getByName
(String name)
Parameters
name
| the name of the project to retrieve |
Returns
- the named project, or
null
if the name does not match an existing project