com.microsoft.azure.storage.blob

Enum LeaseStatus

java.lang.Object

java.lang.Enum<LeaseStatus>

com.microsoft.azure.storage.blob.LeaseStatus

All Implemented Interfaces:

Serializable, Comparable<LeaseStatus>

public enum LeaseStatus
extends Enum<LeaseStatus>

Specifies the lease status of a blob.

You can check the lease status of a blob to determine whether it currently has an active lease (locked for exclusive-write access), or whether it is available for exclusive-write access.

Enum Constant Summary

Enum Constants

Enum Constant and Description
LOCKED Specifies the blob is locked for exclusive-write access.
UNLOCKED Specifies the blob is available to be locked for exclusive-write access.
UNSPECIFIED Specifies the lease status is not specified.

Method Summary

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

Specifies the lease status is not specified.

LOCKED

public static final LeaseStatus LOCKED

Specifies the blob is locked for exclusive-write access.

UNLOCKED

public static final LeaseStatus UNLOCKED

Specifies the blob is available to be locked for exclusive-write access.

Method Detail

values

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

Returns:

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

valueOf

public static LeaseStatus 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 LeaseStatus parse(String typeString)

Parses a lease status from the given string.

Parameters:

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

Returns:

A LeaseStatus value that represents the lease status.