Package com.atlassian.bitbucket.scm.git.worktree

Enum Class GitCheckoutType

java.lang.Object

java.lang.Enum<GitCheckoutType>

com.atlassian.bitbucket.scm.git.worktree.GitCheckoutType

All Implemented Interfaces:

Serializable, Comparable<GitCheckoutType>, Constable

public enum GitCheckoutType
extends Enum<GitCheckoutType>

The type of a git checkout used to initialize a GitWorkTree. For performance reasons, "full" checkouts, in which all files are checkout out, are not supported. Only NONE, which is comparable to git clone --no-checkout, and SPARSE, which is comparable to git clone --sparse, are supported.

Since:

7.14

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
NONE	A checkout without any files checked out, where git status shows unstaged changes as deleting all files.
SPARSE	A checkout initialized as a sparse checkout, where git status shows no changes, but most files are not actually checked out.

Method Summary

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

NONE

public static final GitCheckoutType NONE

A checkout without any files checked out, where git status shows unstaged changes as deleting all files. When working with a NO_CHECKOUT work tree, special care needs to be taken to only stage files of interest. Adding files through git add -u or git commit -a will delete (almost) all files!

SPARSE

public static final GitCheckoutType SPARSE

A checkout initialized as a sparse checkout, where git status shows no changes, but most files are not actually checked out.

Method Details

values

public static GitCheckoutType[] 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 GitCheckoutType 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