com.atlassian.bitbucket.repository

Class AbstractRepositoryRequest.AbstractBuilder<B extends AbstractRepositoryRequest.AbstractBuilder<B>>

java.lang.Object

com.atlassian.bitbucket.util.BuilderSupport

com.atlassian.bitbucket.repository.AbstractRepositoryRequest.AbstractBuilder<B>

Type Parameters:

B - The builder class, used to control the return type on builder methods to provide a fluent API

Direct Known Subclasses:

RepositoryCreateRequest.Builder, RepositoryForkRequest.Builder, RepositoryUpdateRequest.Builder

Enclosing class:

AbstractRepositoryRequest

public abstract static class AbstractRepositoryRequest.AbstractBuilder<B extends AbstractRepositoryRequest.AbstractBuilder<B>>
extends BuilderSupport

Base class for creating builders for repository-related requests.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	forkable Deprecated. will be private in 7.0
protected String	name Deprecated. will be private in 7.0
protected boolean	publiclyAccessible Deprecated. will be private in 7.0

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

NOT_BLANK

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractBuilder()
protected	AbstractBuilder(AbstractRepositoryRequest request)
protected	AbstractBuilder(Repository repository)

Method Summary

Modifier and Type	Method and Description
B	description(String value) Sets the description of the repository.
B	forkable(boolean value) Sets whether the request should mark the repository forkable or not.
B	name(String value) Sets the name to be used for the request.
B	publiclyAccessible(boolean value)
protected abstract B	self() Overridden in concrete builder implementations to return this.

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

Field Detail

forkable

@Deprecated
protected boolean forkable

Deprecated. will be private in 7.0

name

@Deprecated
protected String name

Deprecated. will be private in 7.0

publiclyAccessible

@Deprecated
protected boolean publiclyAccessible

Deprecated. will be private in 7.0

Constructor Detail

AbstractBuilder

protected AbstractBuilder()

AbstractBuilder

protected AbstractBuilder(@Nonnull
                          Repository repository)

AbstractBuilder

protected AbstractBuilder(@Nonnull
                          AbstractRepositoryRequest request)

Method Detail

description

@Nonnull
public B description(@Nullable
                              String value)

Sets the description of the repository.

Parameters:

value - the description of the repository

Returns:

this

Since:

6.2

forkable

@Nonnull
public B forkable(boolean value)

Sets whether the request should mark the repository forkable or not. If this method is not called prior to building the request, its value defaults to true and the repository will be forkable by default.

Parameters:

value - true to mark the repository as forkable, or false to disable forking

Returns:

this

name

@Nonnull
public B name(@Nonnull
                       String value)

Sets the name to be used for the request. The provided value may not be null, empty or contain only whitespace or an exception will be thrown.

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

Parameters:

value - the name for the repository

Returns:

this

Throws:

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

NullPointerException - if the provided value is null

publiclyAccessible

@Nonnull
public B publiclyAccessible(boolean value)

Parameters:

value - whether the repository will be publicly accessible or not.

Returns:

this

self

protected abstract B self()

Overridden in concrete builder implementations to return this.

Returns:

this