Type.BuiltinType (vSphere Automation SDK for Java 7.0.0.1)

java.lang.Object
- com.vmware.vapi.bindings.ApiEnumeration<Type.BuiltinType>
- - com.vmware.vapi.metadata.metamodel.Type.BuiltinType

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

Type
```
public static final class Type.BuiltinType
extends ApiEnumeration<Type.BuiltinType>
```
The BuiltinType enumeration class provides enumeration constant for each of the built-in types present in the interface definition language type system.
See enumerated types description.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Type.BuiltinType.Values
Native Java enum representing this enumeration class.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Type.BuiltinType.Values` Native Java `enum` representing this enumeration class.

Field Summary

Fields
Modifier and Type	Field and Description
`static Type.BuiltinType`	`ANY_ERROR` The built-in type is an arbitrary exception type.
`static Type.BuiltinType`	`BINARY` The built-in type is a binary.
`static Type.BuiltinType`	`BOOLEAN` The built-in type is a boolean.
`static Type.BuiltinType`	`DATE_TIME` The built-in type is a datetime.
`static Type.BuiltinType`	`DOUBLE` The built-in type is a double.
`static Type.BuiltinType`	`DYNAMIC_STRUCTURE` The built-in type is a dynamic structure.
`static Type.BuiltinType`	`ID` The built-in type is an ID.
`static Type.BuiltinType`	`LONG` The built-in type is a long.
`static Type.BuiltinType`	`OPAQUE` The built-in type is an opaque.
`static Type.BuiltinType`	`SECRET` The built-in type is a secret.
`static Type.BuiltinType`	`STRING` The built-in type is a string.
`static Type.BuiltinType`	`URI` The built-in type is an URI.
`static Type.BuiltinType`	`VOID` The built-in type is a void.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Type.BuiltinType.Values`	`getEnumValue()` Returns a native Java `enum` constant representing this enumeration constant.
`boolean`	`isUnknown()` Checks if this enumeration constant is unknown.
`static Type.BuiltinType`	`valueOf(java.lang.String name)` Returns the enumeration constant for the specified name.
`static Type.BuiltinType[]`	`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
  - VOID
```
public static final Type.BuiltinType VOID
```
    The built-in type is a void. The value is null.
  - BOOLEAN
```
public static final Type.BuiltinType BOOLEAN
```
    The built-in type is a boolean. The value is true or false.
  - LONG
```
public static final Type.BuiltinType LONG
```
    The built-in type is a long. The value is a 64 bit signed integer.
  - DOUBLE
```
public static final Type.BuiltinType DOUBLE
```
    The built-in type is a double. The value is a 64 bit floating point number.
  - STRING
```
public static final Type.BuiltinType STRING
```
    The built-in type is a string. The value is a variable-length sequence of zero or more unicode characters.
  - BINARY
```
public static final Type.BuiltinType BINARY
```
    The built-in type is a binary. The value is a variable-length sequence of zero or more bytes.
  - SECRET
```
public static final Type.BuiltinType SECRET
```
    The built-in type is a secret. The value is a variable-length sequence of zero or more unicode characters. The value contains sensitive data that should not be printed or displayed anywhere.
  - DATE_TIME
```
public static final Type.BuiltinType DATE_TIME
```
    The built-in type is a datetime. The value should be in the UTC timezone and the precision is milliseconds.
  - ID
```
public static final Type.BuiltinType ID
```
    The built-in type is an ID. The value represents an identifier for a resource.
  - URI
```
public static final Type.BuiltinType URI
```
    The built-in type is an URI. The value follows the IRI specification in RFC 3987.
  - ANY_ERROR
```
public static final Type.BuiltinType ANY_ERROR
```
    The built-in type is an arbitrary exception type. This is used if the value of a typed element can be one of any user defined named type which is an exception.
  - DYNAMIC_STRUCTURE
```
public static final Type.BuiltinType DYNAMIC_STRUCTURE
```
    The built-in type is a dynamic structure. This is used if the value of a typed element can be one of any user defined named type.
  - OPAQUE
```
public static final Type.BuiltinType OPAQUE
```
    The built-in type is an opaque. This is used if the value of a typed element could be of any type and the actual type will be known only during the execution of the API. This is mostly used in infrastructure interfaces.
- Method Detail
  - values
```
public static Type.BuiltinType[] 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.BuiltinType but is not pre-defined.
    
    Returns:
    
    Array of all pre-defined enumeration constants. Never null.
  - valueOf
```
public static Type.BuiltinType 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.BuiltinType will be returned for the specified name, which will not be one of the pre-defined constant instances. Such new instance maps to the Type.BuiltinType.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 Type.BuiltinType.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 Type.BuiltinType.Values._UNKNOWN enum constant is returned.
    The native Java enum is Type.BuiltinType.Values.
    
    Returns:
    
    The Java enum constant. Never null.

Class Type.BuiltinType

Nested Class Summary

Field Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

VOID

BOOLEAN

LONG

DOUBLE

STRING

BINARY

SECRET

DATE_TIME

ID

URI

ANY_ERROR

DYNAMIC_STRUCTURE

OPAQUE

Method Detail

values

valueOf

isUnknown

getEnumValue