public static final class StructureInfo.Type extends ApiEnumeration<StructureInfo.Type>
Type
enumeration class defines the kind of this structure element.
In the interface definition language, structure element and error element have
similar characteristics. The difference is that only error elements can be used
to describe the exceptions of an operation element.
Modifier and Type | Class and Description |
---|---|
static class |
StructureInfo.Type.Values
Native Java
enum representing this enumeration class. |
Modifier and Type | Field and Description |
---|---|
static StructureInfo.Type |
ERROR
If the type is an error element.
|
static StructureInfo.Type |
STRUCTURE
If the type is a structure element.
|
Modifier and Type | Method and Description |
---|---|
StructureInfo.Type.Values |
getEnumValue()
Returns a native Java
enum constant representing this enumeration
constant. |
boolean |
isUnknown()
Checks if this enumeration constant is unknown.
|
static StructureInfo.Type |
valueOf(java.lang.String name)
Returns the enumeration constant for the specified name.
|
static StructureInfo.Type[] |
values()
Retrieve all enumeration constants pre-defined by this enumeration class.
|
buildNameMap, equals, hashCode, name, toString
public static final StructureInfo.Type STRUCTURE
public static final StructureInfo.Type ERROR
public static StructureInfo.Type[] values()
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.
null
.public static StructureInfo.Type valueOf(java.lang.String 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 StructureInfo.Type.Values._UNKNOWN
enum
constant from the native Java enum
.
name
- The name of the constant to return. Must not be null
.null
.public boolean isUnknown()
valueOf(java.lang.String)
and values()
.true
if this constant is unknown, and false
otherwise.public StructureInfo.Type.Values getEnumValue()
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 StructureInfo.Type.Values._UNKNOWN
enum
constant is returned.
The native Java enum
is StructureInfo.Type.Values
.
enum
constant. Never null
.