com.atlassian.bitbucket.repository

Class RepositoryUpdateRequest.Builder

java.lang.Object

com.atlassian.bitbucket.util.BuilderSupport

com.atlassian.bitbucket.repository.AbstractRepositoryRequest.AbstractBuilder<RepositoryUpdateRequest.Builder>

com.atlassian.bitbucket.repository.RepositoryUpdateRequest.Builder

Enclosing class:

RepositoryUpdateRequest

public static class RepositoryUpdateRequest.Builder
extends AbstractRepositoryRequest.AbstractBuilder<RepositoryUpdateRequest.Builder>

Constructs requests for updating repositories.

Field Summary

Fields inherited from class com.atlassian.bitbucket.util.BuilderSupport

NOT_BLANK

Constructor Summary

Constructors

Constructor and Description
Builder()
Builder(Repository repository) Constructs a new Builder which will update the specified Repository.
Builder(RepositoryUpdateRequest request) Constructs a new Builder which uses as its defaults all the values from the provided request.

Method Summary

Modifier and Type	Method and Description
RepositoryUpdateRequest.Builder	archived(boolean value) Sets the archive state of the repository when it is updated.
RepositoryUpdateRequest	build() Builds a request from the assembled values.
RepositoryUpdateRequest.Builder	defaultBranch(String value) Sets the new default branch name to be applied when the repository is updated.
RepositoryUpdateRequest.Builder	id(int value) Sets the ID of the repository to be updated.
RepositoryUpdateRequest.Builder	project(Project value) Sets the project the repository should be moved to.
protected RepositoryUpdateRequest.Builder	self() Overridden in concrete builder implementations to return this.

Methods inherited from class com.atlassian.bitbucket.repository.AbstractRepositoryRequest.AbstractBuilder

description, forkable, name, publiclyAccessible

Methods inherited from class com.atlassian.bitbucket.util.BuilderSupport

addIf, addIf, addIf, addIf, addIf, addIf, checkNotBlank, requireNonBlank

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
               Repository repository)

Constructs a new Builder which will update the specified Repository. The following values are copied:

• Repository.getId() -> id(int)
• Repository.getName() -> AbstractRepositoryRequest.AbstractBuilder.name(String)
• Repository.isArchived() -> archived(boolean)
• Repository.isForkable() -> AbstractRepositoryRequest.AbstractBuilder.forkable(boolean)
• Repository.isPublic() -> AbstractRepositoryRequest.AbstractBuilder.publiclyAccessible(boolean)

The caller may then change the specific fields they wish to update before building the request. If the request is built immediately, the repository will not be updated in any way.

Parameters:

repository - the repository to update, and from which all default values should be drawn

Builder

public Builder(@Nonnull
               RepositoryUpdateRequest request)

Constructs a new Builder which uses as its defaults all the values from the provided request.

Parameters:

request - the request to copy into the new builder

Method Detail

build

@Nonnull
public RepositoryUpdateRequest build()

Builds a request from the assembled values.

Returns:

the built request

archived

@Nonnull
public RepositoryUpdateRequest.Builder archived(boolean value)

Sets the archive state of the repository when it is updated.

Parameters:

value - true if the repository has been archived, false otherwise.

Returns:

this

Since:

8.0

defaultBranch

@Nonnull
public RepositoryUpdateRequest.Builder defaultBranch(@Nullable
                                                              String value)

Sets the new default branch name to be applied when the repository is updated. If a default branch name is not specified it will not be updated.

Parameters:

value - the new default branch name, or null to retain the existing name

Returns:

this

Since:

7.5

id

@Nonnull
public RepositoryUpdateRequest.Builder id(int value)

Sets the ID of the repository to be updated.

Note: This value is required. If the ID specified does not match an existing repository, or if this method is not called prior to building, an exception will be thrown when attempting to perform the update.

Parameters:

value - the repository's ID

Returns:

this

project

@Nonnull
public RepositoryUpdateRequest.Builder project(@Nullable
                                                        Project value)

Sets the project the repository should be moved to.

Parameters:

value - the project to move the repository to. If null, leave the repository in the existing project

Returns:

this

self

protected RepositoryUpdateRequest.Builder self()

Description copied from class: AbstractRepositoryRequest.AbstractBuilder

Overridden in concrete builder implementations to return this.

Specified by:

self in class AbstractRepositoryRequest.AbstractBuilder<RepositoryUpdateRequest.Builder>

Returns:

this