com.atlassian.bitbucket.repository

Class RepositoryForkRequest.Builder

java.lang.Object

com.atlassian.bitbucket.util.BuilderSupport

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

com.atlassian.bitbucket.repository.RepositoryForkRequest.Builder

Enclosing class:

RepositoryForkRequest

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

Constructs requests for forking 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) Constructs a new Builder which will use the specified Repository as the fork's parent.
Builder(RepositoryForkRequest 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
RepositoryForkRequest	build() Builds a request from the assembled values.
RepositoryForkRequest.Builder	defaultBranch(String value) Sets the default branch name to be applied to the new fork.
RepositoryForkRequest.Builder	name(String value) Sets the name to be used for the request.
RepositoryForkRequest.Builder	parent(Repository value) Sets the repository to be forked, which will be the origin of the fork.
RepositoryForkRequest.Builder	project(Project value) Sets the project to which the parent will be forked.
protected RepositoryForkRequest.Builder	self() Overridden in concrete builder implementations to return this.

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

description, forkable, 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 use the specified Repository as the fork's parent. The parent's name is set as the fork's name, but the parent's project is not set as the fork's project. Since names and slugs must be unique within a project, defaulting both the name and project would produce a request guaranteed to fail unless one property or the other was changed before building.

Parameters:

repository - the parent repository for the new fork

Builder

public Builder(@Nonnull
               RepositoryForkRequest 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 RepositoryForkRequest build()

Builds a request from the assembled values. Before the request is built, it is first verified that a parent was specified and an exception is thrown if it was not.

If no name was explicitly set, the parent repository's name will be set as the fork's name. This ensures the constructed request honours its nullability contract.

Returns:

the built request

Throws:

IllegalStateException - if the parent is null

defaultBranch

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

Sets the default branch name to be applied to the new fork. If a default branch name is not specified, the fork will inherit its parent's default branch.

Parameters:

value - the default branch name, or null to use parent's default branch

Returns:

this

Since:

7.5

name

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

Sets the name to be used for the request.

If this value is null, empty or contains only whitespace, or this method is not called prior to building, the parent's name will be used by default.

Overrides:

name in class AbstractRepositoryRequest.AbstractBuilder<RepositoryForkRequest.Builder>

Parameters:

value - the name for the repository, which may be blank to inherit the parent's name

Returns:

this

parent

@Nonnull
public RepositoryForkRequest.Builder parent(@Nonnull
                                                     Repository value)

Sets the repository to be forked, which will be the origin of the fork.

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

Parameters:

value - the repository to fork

Returns:

this

Throws:

NullPointerException - if the provided value is null

project

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

Sets the project to which the parent will be forked.

If this value is not set, or this method is not called prior to building, the current user's personal project will be used by default.

Parameters:

value - the destination project, which may be null to use the current user's personal project

Returns:

this

self

protected RepositoryForkRequest.Builder self()

Description copied from class: AbstractRepositoryRequest.AbstractBuilder

Overridden in concrete builder implementations to return this.

Specified by:

self in class AbstractRepositoryRequest.AbstractBuilder<RepositoryForkRequest.Builder>

Returns:

this