Repository.State
extends Enum<E extends Enum<E>>| java.lang.Object | ||
| ↳ | java.lang.Enum<E extends java.lang.Enum<E>> | |
| ↳ | com.atlassian.bitbucket.repository.Repository.State | |
Class Overview
Enumerates the possible states for a given repository. In general, repositories will always
be in the available state.
Summary
| Enum Values | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| 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. | |||||||||
| 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. |
|||||||||
| 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. | |||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Retrieves the state associated with the specified
ID. | |||||||||||
Retrieves a unique identifier for this state.
| |||||||||||
Retrieves the status message describing this state.
| |||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Enum
| |||||||||||
|
From class
java.lang.Object
| |||||||||||
|
From interface
java.lang.Comparable
| |||||||||||
Enum Values
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.
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.
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.
Public Methods
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 |
|---|
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
@Nonnull public String getStatusMessage ()
Retrieves the status message describing this state.
Returns
- the state's status message