com.atlassian.bitbucket.commit

Enum CommitListMergeFilter

java.lang.Object

java.lang.Enum<CommitListMergeFilter>

com.atlassian.bitbucket.commit.CommitListMergeFilter

All Implemented Interfaces:

Serializable, Comparable<CommitListMergeFilter>

public enum CommitListMergeFilter
extends Enum<CommitListMergeFilter>

A flag for indicating how merge commits should be filtered.

Since:

4.8

Enum Constant Summary

Enum Constants

Enum Constant and Description
EXCLUDE Exclude merge commits.
INCLUDE Include merge commits.
ONLY Include only merge commits.

Method Summary

Modifier and Type	Method and Description
static CommitListMergeFilter	fromString(String stringValue, CommitListMergeFilter defaultValue) Coerces a string to a CommitListMergeFilter or returns the supplied default value if this is not possible.
static CommitListMergeFilter	valueOf(String name) Returns the enum constant of this type with the specified name.
static CommitListMergeFilter[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

EXCLUDE

public static final CommitListMergeFilter EXCLUDE

Exclude merge commits.

INCLUDE

public static final CommitListMergeFilter INCLUDE

Include merge commits. This does not exclude non-merge commits.

ONLY

public static final CommitListMergeFilter ONLY

Include only merge commits.

Method Detail

values

public static CommitListMergeFilter[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CommitListMergeFilter c : CommitListMergeFilter.values())
    System.out.println(c);

Returns:

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

valueOf

public static CommitListMergeFilter valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

fromString

public static CommitListMergeFilter fromString(@Nonnull
                                               String stringValue,
                                               @Nullable
                                               CommitListMergeFilter defaultValue)

Coerces a string to a CommitListMergeFilter or returns the supplied default value if this is not possible.

Parameters:

stringValue - the string value of the commit list merge filter

defaultValue - the default value to return if coercion is not possible

Returns:

a corresponding CommitListMergeFilter instance