com.atlassian.bitbucket.repository

Class AbstractRepositoryRequest

java.lang.Object

com.atlassian.bitbucket.repository.AbstractRepositoryRequest

Direct Known Subclasses:

RepositoryCreateRequest, RepositoryForkRequest, RepositoryUpdateRequest

public abstract class AbstractRepositoryRequest
extends Object

Base class for Repository-related request classes.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractRepositoryRequest.AbstractBuilder<B extends AbstractRepositoryRequest.AbstractBuilder<B>> Base class for creating builders for repository-related requests.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractRepositoryRequest(AbstractRepositoryRequest.AbstractBuilder builder)
protected	AbstractRepositoryRequest(String name, boolean forkable, boolean publiclyAccessible) Deprecated. in 6.2 for removal in 7.0. Use @{link AbstractRepositoryRequest(AbstractBuilder)} instead

Method Summary

Modifier and Type	Method and Description
String	getDescription() The description for the repository.
String	getName() The name for the repository.
boolean	isForkable() Retrieves a flag indicating whether the repository should be forkable.
boolean	isPublic()

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractRepositoryRequest

@Deprecated
protected AbstractRepositoryRequest(String name,
                                                boolean forkable,
                                                boolean publiclyAccessible)

Deprecated. in 6.2 for removal in 7.0. Use @{link AbstractRepositoryRequest(AbstractBuilder)} instead

Parameters:

name - name

forkable - forkable

publiclyAccessible - publicly accessible

AbstractRepositoryRequest

protected AbstractRepositoryRequest(AbstractRepositoryRequest.AbstractBuilder builder)

Method Detail

getDescription

@Nullable
public String getDescription()

The description for the repository. How this is used depends on the request type:

• RepositoryCreateRequest: Sets the description for the new repository
• RepositoryForkRequest: Sets the description for the new fork
• RepositoryUpdateRequest: Updates the repository's description.

Returns:

the description for the repository

Since:

6.2

getName

@Nonnull
public String getName()

The name for the repository. How this is used depends on the request type:

• RepositoryCreateRequest: Sets the name (and slug) for the new repository
• RepositoryForkRequest: Sets the name (and slug) for the new fork
• RepositoryUpdateRequest: Updates the repository's name, which may also change its slug. Changing a repository's slug will update all of its URLs, including its clone URL

The name provided is used to generate the repository's slug regardless of the request type.

Returns:

the name for the repository

isForkable

public boolean isForkable()

Retrieves a flag indicating whether the repository should be forkable. How this is used depends on the request type:

• RepositoryCreateRequest: Sets whether the new repository will be forkable
• RepositoryForkRequest: Sets whether the new fork itself be forkable
• RepositoryUpdateRequest: Updates whether an existing repository is forkable

Returns:

true if the repository should be forkable; otherwise, false to disable forking

isPublic

public boolean isPublic()

Returns:

true if the project will be made publicly accessible, false otherwise.