com.vmware.vcenter.ovf

Class OvfMessage.Category

java.lang.Object

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

com.vmware.vcenter.ovf.OvfMessage.Category

All Implemented Interfaces:

Serializable

Enclosing class:

OvfMessage

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

The Category enumeration class defines the categories of messages (see OvfMessage).

See enumerated types description.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static OvfMessage.Category	INPUT The user provided input parameters are invalid.
static OvfMessage.Category	SERVER Server error.
static OvfMessage.Category	VALIDATION The OVF descriptor is invalid, for example, syntax errors or schema errors.

Method Summary

Methods

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

VALIDATION

public static final OvfMessage.Category VALIDATION

The OVF descriptor is invalid, for example, syntax errors or schema errors.

INPUT

public static final OvfMessage.Category INPUT

The user provided input parameters are invalid.

SERVER

public static final OvfMessage.Category SERVER

Server error.

Method Detail

values

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

Returns:

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

valueOf

public static OvfMessage.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 OvfMessage.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 OvfMessage.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 OvfMessage.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 OvfMessage.Category.Values._UNKNOWN enum constant is returned.

The native Java enum is OvfMessage.Category.Values.

Returns:

The Java enum constant. Never null.