com.atlassian.bitbucket.repository

Enum Repository.State

java.lang.Object

java.lang.Enum<Repository.State>

com.atlassian.bitbucket.repository.Repository.State

All Implemented Interfaces:

Serializable, Comparable<Repository.State>

Enclosing interface:

Repository

public static enum Repository.State
extends Enum<Repository.State>

Enumerates the possible states for a given repository. In general, repositories will always be in the available state.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AVAILABLE Indicates the repository has been created both in the database and in the associated SCM and may be pulled from or pushed to normally.
INITIALISATION_FAILED Indicates the associated SCM was not able to create the repository's SCM-specific storage, such as a bare clone on disk in git.
INITIALISING Indicates the repository has just been created in the database and the associated SCM is currently in the process of creating its storage.
OFFLINE Indicates that the repository is remotely managed and that the node that manages it is currently offline.

Method Summary

Modifier and Type	Method and Description
static Repository.State	fromId(int id) Retrieves the state associated with the specified ID.
int	getId() Retrieves a unique identifier for this state.
String	getStatusMessage() Retrieves the status message describing this state.
static Repository.State	valueOf(String name) Returns the enum constant of this type with the specified name.
static Repository.State[]	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

AVAILABLE

public static final Repository.State AVAILABLE

Indicates the repository has been created both in the database and in the associated SCM and may be pulled from or pushed to normally.

INITIALISATION_FAILED

public static final Repository.State INITIALISATION_FAILED

Indicates the associated SCM was not able to create the repository's SCM-specific storage, such as a bare clone on disk in git. Repositories in this state exist within the database, but may not be pulled from or pushed to.

INITIALISING

public static final Repository.State INITIALISING

Indicates the repository has just been created in the database and the associated SCM is currently in the process of creating its storage. Repositories in this state may not be pulled from or pushed to.

OFFLINE

public static final Repository.State OFFLINE

Indicates that the repository is remotely managed and that the node that manages it is currently offline.

Since:

7.12

Method Detail

values

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

Returns:

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

valueOf

public static Repository.State 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

getId

public int getId()

Retrieves a unique identifier for this state. Unlike the enum's ordinal or name, this value will never change for a given entry.

Returns:

the state's unique identifier

getStatusMessage

@Nonnull
public String getStatusMessage()

Retrieves the status message describing this state.

Returns:

the state's status message

fromId

public static Repository.State fromId(int id)

Retrieves the state associated with the specified ID.

Parameters:

id - the ID to retrieve a State for

Returns:

the state with the specified ID

Throws:

IllegalArgumentException - if no state exists with the specified ID