Package com.atlassian.bitbucket.pull

Enum Class PullRequestChangeScope

java.lang.Object

java.lang.Enum<PullRequestChangeScope>

com.atlassian.bitbucket.pull.PullRequestChangeScope

All Implemented Interfaces:

Serializable, Comparable<PullRequestChangeScope>, Constable

public enum PullRequestChangeScope
extends Enum<PullRequestChangeScope>

Specifies the scope of the changes for a pull request.

Since:

4.10

See Also:

• PullRequestChangesRequest.getChangeScope()

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALL	No limit is placed on the scope of the changes for the pull request.
RANGE	Limits the scope of the changes for the pull request to one or more commits between PullRequestChangesRequest.getSinceId() and PullRequestChangesRequest.getUntilId().
UNREVIEWED	Limits the scope of the changes for the pull request to the changes which are unreviewed for the current user.

Method Summary

Modifier and Type	Method	Description
static PullRequestChangeScope	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PullRequestChangeScope[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ALL

public static final PullRequestChangeScope ALL

No limit is placed on the scope of the changes for the pull request.

RANGE

public static final PullRequestChangeScope RANGE

Limits the scope of the changes for the pull request to one or more commits between PullRequestChangesRequest.getSinceId() and PullRequestChangesRequest.getUntilId(). If either PullRequestChangesRequest.getSinceId() or PullRequestChangesRequest.getUntilId() are not included in the request, the scope defaults to ALL changes.

Since:

5.0

UNREVIEWED

public static final PullRequestChangeScope UNREVIEWED

Limits the scope of the changes for the pull request to the changes which are unreviewed for the current user. The unreviewed changes are considered to be the changes between the lastReviewedCommit of the current user and the tip of the source branch. If there are no unreviewed changes, the scope defaults to ALL changes.

See Also:

• PullRequestParticipant.getLastReviewedCommit()

Method Details

values

public static PullRequestChangeScope[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static PullRequestChangeScope valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null