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

Class ListBranches

java.lang.Object

com.google.gerrit.server.restapi.project.ListBranches

All Implemented Interfaces:

RestReadView<ProjectResource>, RestView<ProjectResource>

public class ListBranches
extends Object
implements RestReadView<ProjectResource>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NEXT_PAGE_TOKEN_HEADER

Constructor Summary

Constructors

Constructor	Description
ListBranches(GitRepositoryManager repoManager, PermissionBackend permissionBackend, DynamicMap<RestView<BranchResource>> branchViews, UiActions uiActions, WebLinks webLinks)

Method Summary

Modifier and Type	Method	Description
Response<com.google.common.collect.ImmutableList<BranchInfo>>	apply(ProjectResource rsrc)	Process the view operation by reading from the resource.
static String	encodeToken(String token)	Encodes the nextPageToken using proto serialization followed by based64 encoding.
ListBranches	request(ProjectApi.ListRefsRequest<BranchInfo> request)
void	setLimit(int limit)
void	setMatchRegex(String matchRegex)
void	setMatchSubstring(String matchSubstring)
void	setNextPageToken(String token)
void	setStart(int start)

Methods inherited from class java.lang.Object

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

Field Details

NEXT_PAGE_TOKEN_HEADER

public static final String NEXT_PAGE_TOKEN_HEADER

See Also:

• Constant Field Values

Constructor Details

ListBranches

@Inject
public ListBranches(GitRepositoryManager repoManager,
 PermissionBackend permissionBackend,
 DynamicMap<RestView<BranchResource>> branchViews,
 UiActions uiActions,
 WebLinks webLinks)

Method Details

setLimit

public void setLimit(int limit)

setStart

public void setStart(int start)

setNextPageToken

public void setNextPageToken(String token)

setMatchSubstring

public void setMatchSubstring(String matchSubstring)

setMatchRegex

public void setMatchRegex(String matchRegex)

request

public ListBranches request(ProjectApi.ListRefsRequest<BranchInfo> request)

apply

public Response<com.google.common.collect.ImmutableList<BranchInfo>> apply(ProjectResource rsrc)
                                                                    throws RestApiException,
IOException,
PermissionBackendException

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<ProjectResource>

Parameters:

rsrc - resource to read

Returns:

response to return to the client

Throws:

AuthException - the caller is not permitted to access this view.

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

ResourceConflictException - the resource state does not permit this view to make the changes at this time.

RestApiException

IOException

PermissionBackendException

encodeToken

public static String encodeToken(String token)

Encodes the nextPageToken using proto serialization followed by based64 encoding.