com.vmware.content.library.item

Class DownloadSessionModel.State

java.lang.Object

com.vmware.vapi.bindings.ApiEnumeration<DownloadSessionModel.State>

com.vmware.content.library.item.DownloadSessionModel.State

All Implemented Interfaces:

Serializable

Enclosing class:

DownloadSessionModel

public static final class DownloadSessionModel.State
extends ApiEnumeration<DownloadSessionModel.State>

The state of the download session.

See enumerated types description.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DownloadSessionModel.State.Values Native Java enum representing this enumeration class.

Field Summary

Fields

Modifier and Type	Field and Description
static DownloadSessionModel.State	ACTIVE The session is active.
static DownloadSessionModel.State	CANCELED The session has been canceled.
static DownloadSessionModel.State	ERROR Indicates there was an error during the session lifecycle.

Method Summary

Methods

Modifier and Type	Method and Description
DownloadSessionModel.State.Values	getEnumValue() Returns a native Java enum constant representing this enumeration constant.
boolean	isUnknown() Checks if this enumeration constant is unknown.
static DownloadSessionModel.State	valueOf(String name) Returns the enumeration constant for the specified name.
static DownloadSessionModel.State[]	values() Retrieve all enumeration constants pre-defined by this enumeration class.

Methods inherited from class com.vmware.vapi.bindings.ApiEnumeration

equals, hashCode, name, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

ACTIVE

public static final DownloadSessionModel.State ACTIVE

The session is active. Individual files may be in the process of being transferred and may become ready for download at different times.

CANCELED

public static final DownloadSessionModel.State CANCELED

The session has been canceled. On-going downloads may fail. The session will stay in this state until it is either deleted by the user or automatically cleaned up by the Content Library Service.

ERROR

public static final DownloadSessionModel.State ERROR

Indicates there was an error during the session lifecycle.

Method Detail

values

public static DownloadSessionModel.State[] values()

Retrieve all enumeration constants pre-defined by this enumeration class.

Additional instances might exist at runtime, for example to represent a new constant added to this enumeration class in subsequent version of the API. Such new constant is represented as instance of DownloadSessionModel.State but is not pre-defined.

Returns:

Array of all pre-defined enumeration constants. Never null.

valueOf

public static DownloadSessionModel.State valueOf(String name)

Returns the enumeration constant for the specified name.

If the name matches exactly the identifier used to declare an enumeration constant from this enumeration class, the constant in question will be returned.

Otherwise, a new instance of DownloadSessionModel.State will be returned for the specified name, which will not be one of the pre-defined constant instances. Such new instance maps to the DownloadSessionModel.State.Values._UNKNOWN enum constant from the native Java enum.

Parameters:

name - The name of the constant to return. Must not be null.

Returns:

Enumeration constant for the specified name. Never null.

isUnknown

public boolean isUnknown()

Checks if this enumeration constant is unknown. Unknown is a constant that is not one of the pre-defined ones for this enumeration class. Also see valueOf(java.lang.String) and values().

Returns:

true if this constant is unknown, and false otherwise.

getEnumValue

public DownloadSessionModel.State.Values getEnumValue()

Returns a native Java enum constant representing this enumeration constant. The result is useful for usual handling of Java enum, for example it can be used in switch statements.

If this enumeration constant is unknown, then DownloadSessionModel.State.Values._UNKNOWN enum constant is returned.

The native Java enum is DownloadSessionModel.State.Values.

Returns:

The Java enum constant. Never null.