com.vmware.snapservice

Class TimeUnit

java.lang.Object

com.vmware.vapi.bindings.ApiEnumeration<TimeUnit>

com.vmware.snapservice.TimeUnit

All Implemented Interfaces:

java.io.Serializable

public final class TimeUnit
extends com.vmware.vapi.bindings.ApiEnumeration<TimeUnit>

The TimeUnit enumeration class contains the supported values for how often snapshots are taken.

See enumerated types description.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static TimeUnit	DAY Day.
static TimeUnit	HOUR Hours.
static TimeUnit	MINUTE Minutes.
static TimeUnit	MONTH Months.
static TimeUnit	WEEK Weeks.

Method Summary

Modifier and Type	Method and Description
TimeUnit.Values	getEnumValue() Returns a native Java enum constant representing this enumeration constant.
boolean	isUnknown() Checks if this enumeration constant is unknown.
static TimeUnit	valueOf(java.lang.String name) Returns the enumeration constant for the specified name.
static TimeUnit[]	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

MINUTE

public static final TimeUnit MINUTE

Minutes.

HOUR

public static final TimeUnit HOUR

Hours.

DAY

public static final TimeUnit DAY

Day.

WEEK

public static final TimeUnit WEEK

Weeks.

MONTH

public static final TimeUnit MONTH

Months.

Method Detail

values

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

Returns:

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

valueOf

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

The native Java enum is TimeUnit.Values.

Returns:

The Java enum constant. Never null.