ProjectsCollection (Gerrit Review Plugin API Documentation)

java.lang.Object
- com.google.gerrit.server.project.ProjectsCollection

All Implemented Interfaces:: com.google.gerrit.extensions.restapi.AcceptsCreate<com.google.gerrit.extensions.restapi.TopLevelResource>, com.google.gerrit.extensions.restapi.RestCollection<com.google.gerrit.extensions.restapi.TopLevelResource,ProjectResource>

public class ProjectsCollection
extends java.lang.Object
implements com.google.gerrit.extensions.restapi.RestCollection<com.google.gerrit.extensions.restapi.TopLevelResource,ProjectResource>, com.google.gerrit.extensions.restapi.AcceptsCreate<com.google.gerrit.extensions.restapi.TopLevelResource>

Method Summary

Methods
Modifier and Type	Method and Description
`CreateProject`	`create(com.google.gerrit.extensions.restapi.TopLevelResource parent, com.google.gerrit.extensions.restapi.IdString name)`
`com.google.gerrit.extensions.restapi.RestView<com.google.gerrit.extensions.restapi.TopLevelResource>`	`list()`
`ProjectResource`	`parse(java.lang.String id)` Parses a project ID from a request body and returns the project.
`ProjectResource`	`parse(java.lang.String id, boolean checkVisibility)` Parses a project ID from a request body and returns the project.
`ProjectResource`	`parse(com.google.gerrit.extensions.restapi.TopLevelResource parent, com.google.gerrit.extensions.restapi.IdString id)`
`com.google.gerrit.extensions.registration.DynamicMap<com.google.gerrit.extensions.restapi.RestView<ProjectResource>>`	`views()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - list
```
public com.google.gerrit.extensions.restapi.RestView<com.google.gerrit.extensions.restapi.TopLevelResource> list()
```
    Specified by:
    
    list in interface com.google.gerrit.extensions.restapi.RestCollection<com.google.gerrit.extensions.restapi.TopLevelResource,ProjectResource>
  - parse
```
public ProjectResource parse(com.google.gerrit.extensions.restapi.TopLevelResource parent,
                    com.google.gerrit.extensions.restapi.IdString id)
                      throws com.google.gerrit.extensions.restapi.ResourceNotFoundException,
                             java.io.IOException
```
    Specified by:
    
    parse in interface com.google.gerrit.extensions.restapi.RestCollection<com.google.gerrit.extensions.restapi.TopLevelResource,ProjectResource>
    
    Throws:
    
    com.google.gerrit.extensions.restapi.ResourceNotFoundException
    
    java.io.IOException
  - parse
```
public ProjectResource parse(java.lang.String id)
                      throws com.google.gerrit.extensions.restapi.UnprocessableEntityException,
                             java.io.IOException
```
    Parses a project ID from a request body and returns the project.
    
    Parameters:
    id - ID of the project, can be a project name
    
    Returns:
    the project
    
    Throws:
    
    com.google.gerrit.extensions.restapi.UnprocessableEntityException - thrown if the project ID cannot be resolved or if the project is not visible to the calling user
    
    java.io.IOException - thrown when there is an error.
  - parse
```
public ProjectResource parse(java.lang.String id,
                    boolean checkVisibility)
                      throws com.google.gerrit.extensions.restapi.UnprocessableEntityException,
                             java.io.IOException
```
    Parses a project ID from a request body and returns the project.
    
    Parameters:
    id - ID of the project, can be a project name
    checkVisibility - Whether to check or not that project is visible to the calling user
    
    Returns:
    the project
    
    Throws:
    
    com.google.gerrit.extensions.restapi.UnprocessableEntityException - thrown if the project ID cannot be resolved or if the project is not visible to the calling user and checkVisibility is true.
    
    java.io.IOException - thrown when there is an error.
  - views
```
public com.google.gerrit.extensions.registration.DynamicMap<com.google.gerrit.extensions.restapi.RestView<ProjectResource>> views()
```
    Specified by:
    
    views in interface com.google.gerrit.extensions.restapi.RestCollection<com.google.gerrit.extensions.restapi.TopLevelResource,ProjectResource>
  - create
```
public CreateProject create(com.google.gerrit.extensions.restapi.TopLevelResource parent,
                   com.google.gerrit.extensions.restapi.IdString name)
```
    Specified by:
    
    create in interface com.google.gerrit.extensions.restapi.AcceptsCreate<com.google.gerrit.extensions.restapi.TopLevelResource>

Class ProjectsCollection

Method Summary

Methods inherited from class java.lang.Object

Method Detail

list

parse

parse

parse

views

create