com.vmware.vapi.metadata.metamodel

Class ElementValue.Type

java.lang.Object

com.vmware.vapi.bindings.ApiEnumeration<ElementValue.Type>

com.vmware.vapi.metadata.metamodel.ElementValue.Type

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

ElementValue

public static final class ElementValue.Type
extends ApiEnumeration<ElementValue.Type>

The Type enumeration class defines the valid types for values in metadata elements.

See enumerated types description.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static ElementValue.Type	LONG Indicates the type of the value is a long (64 bit signed integer).
static ElementValue.Type	STRING Indicates the type of the value is a string (a variable length sequence of characters).
static ElementValue.Type	STRING_LIST Indicates the type of the value is a list of strings.
static ElementValue.Type	STRUCTURE_REFERENCE Indicates the type of the value is an identifier for a structure element.
static ElementValue.Type	STRUCTURE_REFERENCE_LIST Indicates the type of the value is a list of identifiers for a structure element.

Method Summary

Methods

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

LONG

public static final ElementValue.Type LONG

Indicates the type of the value is a long (64 bit signed integer).

STRING

public static final ElementValue.Type STRING

Indicates the type of the value is a string (a variable length sequence of characters). The encoding is UTF-8.

STRING_LIST

public static final ElementValue.Type STRING_LIST

Indicates the type of the value is a list of strings.

STRUCTURE_REFERENCE

public static final ElementValue.Type STRUCTURE_REFERENCE

Indicates the type of the value is an identifier for a structure element.

STRUCTURE_REFERENCE_LIST

public static final ElementValue.Type STRUCTURE_REFERENCE_LIST

Indicates the type of the value is a list of identifiers for a structure element.

Method Detail

values

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

Returns:

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

valueOf

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

The native Java enum is ElementValue.Type.Values.

Returns:

The Java enum constant. Never null.