com.vmware.content.library.item.downloadsession

Class FileTypes.PrepareStatus

java.lang.Object

com.vmware.vapi.bindings.ApiEnumeration<FileTypes.PrepareStatus>

com.vmware.content.library.item.downloadsession.FileTypes.PrepareStatus

All Implemented Interfaces:

java.io.Serializable

Enclosing interface:

FileTypes

public static final class FileTypes.PrepareStatus
extends ApiEnumeration<FileTypes.PrepareStatus>

The PrepareStatus enumeration class defines the state of the file in preparation for download.

See enumerated types description.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FileTypes.PrepareStatus.Values Native Java enum representing this enumeration class.

Field Summary

Fields

Modifier and Type	Field and Description
static FileTypes.PrepareStatus	ERROR Prepare failed.
static FileTypes.PrepareStatus	PREPARE_REQUESTED A prepare has been requested, however the server hasn't started the preparation yet.
static FileTypes.PrepareStatus	PREPARED Prepare succeeded.
static FileTypes.PrepareStatus	PREPARING A prepare has been requested and the file is in the process of being prepared.
static FileTypes.PrepareStatus	UNPREPARED The file hasn't been requested for preparation.

Method Summary

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

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

buildNameMap, equals, hashCode, name, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

UNPREPARED

public static final FileTypes.PrepareStatus UNPREPARED

The file hasn't been requested for preparation.

PREPARE_REQUESTED

public static final FileTypes.PrepareStatus PREPARE_REQUESTED

A prepare has been requested, however the server hasn't started the preparation yet.

PREPARING

public static final FileTypes.PrepareStatus PREPARING

A prepare has been requested and the file is in the process of being prepared.

PREPARED

public static final FileTypes.PrepareStatus PREPARED

Prepare succeeded. The file is ready for download.

ERROR

public static final FileTypes.PrepareStatus ERROR

Prepare failed.

Method Detail

values

public static FileTypes.PrepareStatus[] 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 FileTypes.PrepareStatus but is not pre-defined.

Returns:

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

valueOf

public static FileTypes.PrepareStatus valueOf(java.lang.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 FileTypes.PrepareStatus will be returned for the specified name, which will not be one of the pre-defined constant instances. Such new instance maps to the FileTypes.PrepareStatus.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 FileTypes.PrepareStatus.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 FileTypes.PrepareStatus.Values._UNKNOWN enum constant is returned.

The native Java enum is FileTypes.PrepareStatus.Values.

Returns:

The Java enum constant. Never null.