com.atlassian.bitbucket.project

Class ProjectSearchRequest.Builder

java.lang.Object

com.atlassian.bitbucket.project.ProjectSearchRequest.Builder

Enclosing class:

ProjectSearchRequest

public static class ProjectSearchRequest.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder()
Builder(ProjectSearchRequest request) Constructs a new Builder which will copy initial values from the provided request.

Method Summary

Modifier and Type	Method and Description
ProjectSearchRequest	build() Assembles a new ProjectSearchRequest from the provided values.
ProjectSearchRequest.Builder	name(String value) When set, limits returned projects to only those whose names contain the provided value.
ProjectSearchRequest.Builder	permission(Permission value) When set, limits returned projects to only those for which the current user has the required Permission.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Builder

public Builder(@Nonnull
               ProjectSearchRequest request)

Constructs a new Builder which will copy initial values from the provided request.

Parameters:

request - request to copy

Method Detail

build

@Nonnull
public ProjectSearchRequest build()

Assembles a new ProjectSearchRequest from the provided values.

Returns:

a new request

name

@Nonnull
public ProjectSearchRequest.Builder name(@Nullable
                                                  String value)

When set, limits returned projects to only those whose names contain the provided value. Matching is performed in a case-insensitive manner, and will match anywhere within projects' names.

Note: Values containing only whitespace are ignored, and will not be applied. Additionally, leading and trailing whitespace are trimmed.

Parameters:

value - filter text match against project names, or null to return projects regardless of name

Returns:

this

permission

@Nonnull
public ProjectSearchRequest.Builder permission(@Nullable
                                                        Permission value)

When set, limits returned projects to only those for which the current user has the required Permission. The provided value may be null, in which case projects will automatically be limited to those for which the current user has VIEW permission.

Parameters:

value - the required permission, or null to default to VIEW

Returns:

this

Throws:

IllegalArgumentException - if the provided Permission is not project related