com.atlassian.bitbucket.commit

Class CommitsBetweenRequest.Builder

java.lang.Object

com.atlassian.bitbucket.util.BuilderSupport

com.atlassian.bitbucket.commit.AbstractCommitsRequest.AbstractCommitsRequestBuilder<CommitsBetweenRequest.Builder>

com.atlassian.bitbucket.commit.CommitsBetweenRequest.Builder

Enclosing class:

CommitsBetweenRequest

public static class CommitsBetweenRequest.Builder
extends AbstractCommitsRequest.AbstractCommitsRequestBuilder<CommitsBetweenRequest.Builder>

Field Summary

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

NOT_BLANK

Constructor Summary

Constructors

Constructor and Description
Builder(CommitsBetweenRequest request) Creates a new Builder by copying the specified request.
Builder(PullRequest pullRequest) Creates a new Builder with defaults appropriate for retrieving the commits which are included by the specified PullRequest.
Builder(Repository repository)

Method Summary

Modifier and Type	Method and Description
CommitsBetweenRequest	build()
CommitsBetweenRequest.Builder	exclude(Iterable<String> values)
CommitsBetweenRequest.Builder	exclude(String value, String... values)
CommitsBetweenRequest.Builder	include(Iterable<String> values)
CommitsBetweenRequest.Builder	include(String value, String... values)
CommitsBetweenRequest.Builder	secondaryRepository(Repository value)
protected CommitsBetweenRequest.Builder	self()

Methods inherited from class com.atlassian.bitbucket.commit.AbstractCommitsRequest.AbstractCommitsRequestBuilder

followRenames, ignoreMissing, maxMessageLength, merges, order, path, paths, paths, propertyKey, propertyKeys, propertyKeys

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(@Nonnull
               Repository repository)

Builder

public Builder(@Nonnull
               CommitsBetweenRequest request)

Creates a new Builder by copying the specified request.

Parameters:

request - the request to copy

Builder

public Builder(@Nonnull
               PullRequest pullRequest)

Creates a new Builder with defaults appropriate for retrieving the commits which are included by the specified PullRequest.

The new builder:

• Uses the to ref's Repository as the repository for the request
• Uses the from ref's Repository as the secondary repository, if the provided PullRequest is cross-repository
• Includes the from ref
• Excludes the to ref

Parameters:

pullRequest - the pull request to retrieve commits for

Method Detail

build

@Nonnull
public CommitsBetweenRequest build()

Returns:

a new CommitsBetweenRequest assembled from the provided values

Throws:

IllegalStateException - if a secondary repository was specified and it belongs to a different hierarchy than the primary repository

exclude

@Nonnull
public CommitsBetweenRequest.Builder exclude(@Nullable
                                                      String value,
                                                      @Nullable
                                                      String... values)

exclude

@Nonnull
public CommitsBetweenRequest.Builder exclude(@Nullable
                                                      Iterable<String> values)

include

@Nonnull
public CommitsBetweenRequest.Builder include(@Nullable
                                                      String value,
                                                      @Nullable
                                                      String... values)

include

@Nonnull
public CommitsBetweenRequest.Builder include(@Nullable
                                                      Iterable<String> values)

secondaryRepository

@Nonnull
public CommitsBetweenRequest.Builder secondaryRepository(@Nullable
                                                                  Repository value)

self

protected CommitsBetweenRequest.Builder self()

Specified by:

self in class AbstractCommitsRequest.AbstractCommitsRequestBuilder<CommitsBetweenRequest.Builder>