com.microsoft.azure.storage.blob

Enum LeaseState

java.lang.Object

java.lang.Enum<LeaseState>

com.microsoft.azure.storage.blob.LeaseState

All Implemented Interfaces:

Serializable, Comparable<LeaseState>

public enum LeaseState
extends Enum<LeaseState>

The lease state of a resource.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AVAILABLE The lease is in the Available state.
BREAKING The lease is in the Breaking state.
BROKEN The lease is in the Broken state.
EXPIRED The lease is in the Expired state.
LEASED The lease is in the Leased state.
UNSPECIFIED The lease state is not specified.

Method Summary

Modifier and Type	Method and Description
protected static LeaseState	parse(String typeString) Parses a lease state from the given string.
static LeaseState	valueOf(String name) Returns the enum constant of this type with the specified name.
static LeaseState[]	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

UNSPECIFIED

public static final LeaseState UNSPECIFIED

The lease state is not specified.

AVAILABLE

public static final LeaseState AVAILABLE

The lease is in the Available state.

LEASED

public static final LeaseState LEASED

The lease is in the Leased state.

EXPIRED

public static final LeaseState EXPIRED

The lease is in the Expired state.

BREAKING

public static final LeaseState BREAKING

The lease is in the Breaking state.

BROKEN

public static final LeaseState BROKEN

The lease is in the Broken state.

Method Detail

values

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

Returns:

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

valueOf

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

parse

protected static LeaseState parse(String typeString)

Parses a lease state from the given string.

Parameters:

typeString - A String which contains the lease state to parse.

Returns:

A LeaseStatus value that represents the lease status.