Package com.google.gerrit.server.restapi.project

Class QueryProjects

java.lang.Object

com.google.gerrit.server.restapi.project.QueryProjects

All Implemented Interfaces:

RestReadView<TopLevelResource>, RestView<TopLevelResource>

public class QueryProjects
extends Object
implements RestReadView<TopLevelResource>

Implements the GET /projects/?query=QUERY endpoint.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	QueryProjects(com.google.gerrit.index.project.ProjectIndexCollection indexes, ProjectQueryBuilder queryBuilder, com.google.inject.Provider<ProjectQueryProcessor> queryProcessorProvider, ProjectJson json)

Method Summary

Modifier and Type	Method	Description
List<ProjectInfo>	apply()
Response<List<ProjectInfo>>	apply(TopLevelResource resource)	Process the view operation by reading from the resource.
QueryProjects	withLimit(int limit)
QueryProjects	withQuery(String query)
QueryProjects	withStart(int start)

Methods inherited from class java.lang.Object

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

Constructor Details

QueryProjects

@Inject
protected QueryProjects(com.google.gerrit.index.project.ProjectIndexCollection indexes,
 ProjectQueryBuilder queryBuilder,
 com.google.inject.Provider<ProjectQueryProcessor> queryProcessorProvider,
 ProjectJson json)

Method Details

withQuery

@CanIgnoreReturnValue
public QueryProjects withQuery(String query)

withLimit

@CanIgnoreReturnValue
public QueryProjects withLimit(int limit)

withStart

@CanIgnoreReturnValue
public QueryProjects withStart(int start)

apply

public Response<List<ProjectInfo>> apply(TopLevelResource resource)
                                  throws BadRequestException,
MethodNotAllowedException

Description copied from interface: RestReadView

Process the view operation by reading from the resource.

The value of the returned response is automatically converted to JSON unless it is a BinaryResult.

The returned response defines the status code that is returned to the client. For RestReadViews this is usually 200 OK, but other 2XX or 3XX status codes are also possible (e.g. Response.Redirect can be returned for 302 Found).

Throwing a subclass of RestApiException results in a 4XX response to the client. For any other exception the client will get a 500 Internal Server Error response.

Specified by:

apply in interface RestReadView<TopLevelResource>

Parameters:

resource - resource to read

Returns:

response to return to the client

Throws:

BadRequestException - the request was incorrectly specified and cannot be handled by this view.

MethodNotAllowedException

apply

public List<ProjectInfo> apply()
                        throws BadRequestException,
MethodNotAllowedException

Throws:

BadRequestException

MethodNotAllowedException