com.vmware.vapi.metadata.metamodel

Class ConstantValue.Category

java.lang.Object

com.vmware.vapi.bindings.ApiEnumeration<ConstantValue.Category>

com.vmware.vapi.metadata.metamodel.ConstantValue.Category

All Implemented Interfaces:

Serializable

Enclosing class:

ConstantValue

public static final class ConstantValue.Category
extends ApiEnumeration<ConstantValue.Category>

The Category enumeration class defines enumeration constants for the valid kinds of values.

See enumerated types description.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static ConstantValue.Category	LIST Indicates the type of constant value is a list.
static ConstantValue.Category	PRIMITIVE Indicates the type of constant value is primitive.

Method Summary

Methods

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

PRIMITIVE

public static final ConstantValue.Category PRIMITIVE

Indicates the type of constant value is primitive.

LIST

public static final ConstantValue.Category LIST

Indicates the type of constant value is a list.

Method Detail

values

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

Returns:

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

valueOf

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

The native Java enum is ConstantValue.Category.Values.

Returns:

The Java enum constant. Never null.