com.atlassian.bitbucket.scm.git.command.revlist

Enum GitRevListWalk

java.lang.Object

java.lang.Enum<GitRevListWalk>

com.atlassian.bitbucket.scm.git.command.revlist.GitRevListWalk

All Implemented Interfaces:

Serializable, Comparable<GitRevListWalk>

public enum GitRevListWalk
extends Enum<GitRevListWalk>

Enumerates the possible traversal (walk) modes for git rev-list, controlling use of the --do-walk and --no-walk flags.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEFAULT Apply git rev-list's default behaviour.
DO_WALK Walk commit ancestors.
NO_WALK Do not walk commit ancestry; instead, only return the explicitly-requested commits.
NO_WALK_UNSORTED A variant of --no-walk introduced in Git 1.8.0 which returns the commits in the same order they were requested in where --no-walk sorts them by date.

Method Summary

Modifier and Type	Method and Description
String	getFlag()
boolean	isFlagged()
static GitRevListWalk	valueOf(String name) Returns the enum constant of this type with the specified name.
static GitRevListWalk[]	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

DEFAULT

public static final GitRevListWalk DEFAULT

Apply git rev-list's default behaviour. For Git 1.x and 2.x, this is a synonym for DO_WALK.

DO_WALK

public static final GitRevListWalk DO_WALK

Walk commit ancestors.

NO_WALK

public static final GitRevListWalk NO_WALK

Do not walk commit ancestry; instead, only return the explicitly-requested commits. Commits are sorted when using this flag, so, while only requested commits will be returned, they may not be returned in the same order they were requested in. To maintain the order, use --no-walk=unsorted instead.

Note: When using this mode, no excludes can be provided; processing excludes requires walking ancestry.

NO_WALK_UNSORTED

public static final GitRevListWalk NO_WALK_UNSORTED

A variant of --no-walk introduced in Git 1.8.0 which returns the commits in the same order they were requested in where --no-walk sorts them by date.

Note: When using this mode, no excludes can be provided; processing excludes requires walking ancestry.

Since:

4.12

Method Detail

values

public static GitRevListWalk[] 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 (GitRevListWalk c : GitRevListWalk.values())
    System.out.println(c);

Returns:

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

valueOf

public static GitRevListWalk 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

getFlag

@Nullable
public String getFlag()

isFlagged

public boolean isFlagged()