com.atlassian.bitbucket.repository

Class RepositoryCreateRequest.Builder

java.lang.Object

com.atlassian.bitbucket.util.BuilderSupport

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

com.atlassian.bitbucket.repository.RepositoryCreateRequest.Builder

Enclosing class:

RepositoryCreateRequest

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

Constructs requests for creating new repositories.

Field Summary

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

forkable, name, publiclyAccessible

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

NOT_BLANK

Constructor Summary

Constructors

Constructor and Description
Builder()
Builder(Repository repository)
Builder(RepositoryCreateRequest request)

Method Summary

Modifier and Type	Method and Description
RepositoryCreateRequest	build() Builds a request from the assembled values.
RepositoryCreateRequest.Builder	defaultBranch(String value) Sets the default branch name to be applied when the repository is created.
RepositoryCreateRequest.Builder	project(Project value) Sets the project in which the repository will be created.
RepositoryCreateRequest.Builder	scmId(String value) Sets the SCM to be used by the new repository.
protected RepositoryCreateRequest.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)

Builder

public Builder(@Nonnull
               RepositoryCreateRequest request)

Method Detail

build

@Nonnull
public RepositoryCreateRequest build()

Builds a request from the assembled values. Before the request is built, it is first verified that a name, project and SCM ID were specified, and an exception is thrown if any are missing.

Returns:

the built request

Throws:

IllegalStateException - if the name or SCM ID are blank (empty, or containing only whitespace), or the project(Project) is null

defaultBranch

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

Sets the default branch name to be applied when the repository is created. If a default branch name is not specified, repository creation will fall back on the instance- or SCM-level default, in that order.

Parameters:

value - the default branch name, or null to use the instance- or SCM-level default

Returns:

this

Since:

7.5

project

@Nonnull
public RepositoryCreateRequest.Builder project(@Nonnull
                                                        Project value)

Sets the project in which the repository will be created.

Note: This value is required. If this method is not called prior to building the request, an exception will be thrown.

Parameters:

value - the destination project

Returns:

this

Throws:

NullPointerException - if the provided value is null

scmId

@Nonnull
public RepositoryCreateRequest.Builder scmId(@Nonnull
                                                      String value)

Sets the SCM to be used by the new repository.

Note: This value is required. If this method is not called prior to building the request, an exception will be thrown.

Parameters:

value - the SCM used to handle the repository

Returns:

this

Throws:

IllegalArgumentException - if the provided value is empty or contains only whitespace

NullPointerException - if the provided value is null

self

protected RepositoryCreateRequest.Builder self()

Description copied from class: AbstractRepositoryRequest.AbstractBuilder

Overridden in concrete builder implementations to return this.

Specified by:

self in class AbstractRepositoryRequest.AbstractBuilder<RepositoryCreateRequest.Builder>

Returns:

this