com.atlassian.bitbucket.repository

Class RepositorySearchRequest

java.lang.Object

com.atlassian.bitbucket.repository.RepositorySearchRequest

public class RepositorySearchRequest
extends Object

Request for searching repositories. The purpose and behaviour of each field is described on its accessor.

The term "prefix-match", when used in this documentation, describes a string matching process that satisfies the following criteria:

• the matched value starts with the provided filter value
• the matching is performed in a case-insensitive manner
• the filter string's leading and trailing whitespace characters are ignored
• a blank filter (null, or whitespace characters only) is treated as 'empty' and results in all repositories being returned for the purpose of that particular filter (note that other filters specified in conjunction with that filter may still limit the final result)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RepositorySearchRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	getName() When set, limits returned repositories to only those that prefix-match the provided value according to the rules described in the class header.
Permission	getPermission() When set, limits returned repositories to only those for which the current user has the required Permission.
String	getProjectName() When set, limits returned repositories to only those, whose project's name prefix-match the provided value.
Repository.State	getState() When set, limits returned repositories to only those that are in the specified state.
RepositoryVisibility	getVisibility() When set, limits returned repositories to only those which match the specified visibility.
boolean	hasName() Retrieves a flag indicating whether name text has been set.
boolean	hasPermission() Retrieves a flag indicating whether a specific permission has been set.
boolean	hasProjectName() Retrieves a flag indicating whether getProjectName() projectName} text has been set.
boolean	hasState() Retrieves a flag indicating whether getState() state} has been set.
boolean	hasVisibility() Retrieves a flag indicating whether a specific visibility has been set.
boolean	isEmpty() Checks whether this request is considered empty, that is, none of the filters have been set.

Methods inherited from class java.lang.Object

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

Method Detail

getName

@Nullable
public String getName()

When set, limits returned repositories to only those that prefix-match the provided value according to the rules described in the class header.

If this field is not set, it is assumed that all repositories shall be returned, regardless of the repository name. Applying the projectName filter would still limit the results to matching project names in such case.

Returns:

filter text to match against repository names (and possibly project names), or null to return repositories regardless of name.

See Also:

getProjectName()

getProjectName

@Nullable
public String getProjectName()

When set, limits returned repositories to only those, whose project's name prefix-match the provided value.

If this field is not set, it is assumed that all repositories shall be returned, regardless of the project name. Applying other filters would still limit the final results in such case.

Returns:

filter text to match against project names, or null to return repositories regardless of the project name

See Also:

getName()

getState

@Nullable
public Repository.State getState()

When set, limits returned repositories to only those that are in the specified state. The provided value may be null, in which case no additional restriction is applied to the search.

Returns:

the required repository state, or null

Since:

5.13

getPermission

@Nullable
public Permission getPermission()

When set, limits returned repositories to only those for which the current user has the required Permission. The provided value may be null, in which case a default permission Permission.REPO_READ will be used.

Returns:

the required repository permission, or null to default to Permission.REPO_READ

getVisibility

@Nullable
public RepositoryVisibility getVisibility()

When set, limits returned repositories to only those which match the specified visibility. The provided value may be null, in which case no additional restriction is applied to the search.

Returns:

the required repository visibility, or null to return repositories regardless of visibility.

See Also:

RepositoryVisibility

hasName

public boolean hasName()

Retrieves a flag indicating whether name text has been set.

Returns:

true if getName() is not null or whitespace, false otherwise

See Also:

getName()

hasProjectName

public boolean hasProjectName()

Retrieves a flag indicating whether getProjectName() projectName} text has been set.

Returns:

true if getName() is not null or whitespace, false otherwise

hasPermission

public boolean hasPermission()

Retrieves a flag indicating whether a specific permission has been set. If no explicit permission has been set, the search will default to Permission.REPO_READ.

Returns:

true if getPermission() is not null, false otherwise

See Also:

getPermission()

hasState

public boolean hasState()

Retrieves a flag indicating whether getState() state} has been set.

Returns:

true if getState() ()} is not null, false otherwise

Since:

5.13

hasVisibility

public boolean hasVisibility()

Retrieves a flag indicating whether a specific visibility has been set.

Returns:

true if getVisibility() is not null, false otherwise

See Also:

getVisibility()

isEmpty

public boolean isEmpty()

Checks whether this request is considered empty, that is, none of the filters have been set.

Returns:

true, if none of the filter fields on this request have been set, false otherwise

See Also:

hasName(), hasProjectName(), hasPermission(), hasVisibility()