Package com.atlassian.bitbucket.scm.bulk

Enum Class BulkContentDisposition

java.lang.Object

java.lang.Enum<BulkContentDisposition>

com.atlassian.bitbucket.scm.bulk.BulkContentDisposition

All Implemented Interfaces:

Serializable, Comparable<BulkContentDisposition>, Constable

public enum BulkContentDisposition
extends Enum<BulkContentDisposition>

Returned by BulkContentCallback.accept(com.atlassian.bitbucket.scm.bulk.BulkFile) to signal what to do next to the caller.

Since:

4.2

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
DONE	Skip the current file, and do not offer any further files.
SKIP	Skip the current file, but continue offering subsequent files.
STREAM	Stream the current file, allowing its bytes to be read.

Method Summary

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

DONE

public static final BulkContentDisposition DONE

Skip the current file, and do not offer any further files. This can be used to terminate streaming early.

STREAM

public static final BulkContentDisposition STREAM

Stream the current file, allowing its bytes to be read. For deleted files, this is equivalent to SKIP.

SKIP

public static final BulkContentDisposition SKIP

Skip the current file, but continue offering subsequent files. This can be used to implement filtering, rejecting some files but accepting others based on the BulkFile.

Method Details

values

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