com.atlassian.bitbucket.scm.bulk

Enum BulkContentDisposition

java.lang.Object

java.lang.Enum<BulkContentDisposition>

com.atlassian.bitbucket.scm.bulk.BulkContentDisposition

All Implemented Interfaces:

Serializable, Comparable<BulkContentDisposition>

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

Enum Constant Summary

Enum Constants

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

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 Detail

values

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

Returns:

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

valueOf

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