public class Error extends ApiError implements Serializable, StaticStructure
Error
exception describes theproperties common to all standard
exceptions.
This exception serves two purposes:
getMessages()
to a human. Modifier and Type | Class and Description |
---|---|
static class |
Error.Builder
Builder class for
Error . |
Constructor and Description |
---|
Error()
Default constructor.
|
Error(List<LocalizableMessage> messages,
Structure data) |
Modifier and Type | Method and Description |
---|---|
<T extends Structure> |
_convertTo(Class<T> clazz)
Converts this structure into an instance of the provided class structure
if possible.
|
String |
_getCanonicalName()
Returns the canonical name of the structure.
|
static String |
_getCanonicalTypeName()
Returns the canonical type name.
|
static com.vmware.vapi.bindings.type.ErrorType |
_getClassType()
WARNING: Internal API, subject to change in future versions.
|
StructValue |
_getDataValue()
Returns this
Structure represented in the dynamic
DataValue model. |
DataValue |
_getDynamicField(String fieldName)
Get dynamic filed value.
|
Set<String> |
_getDynamicFieldNames()
Get the names of the dynamic fields in the structure.
|
com.vmware.vapi.bindings.type.ErrorType |
_getType()
WARNING: Internal API, subject to change in future versions.
|
boolean |
_hasTypeNameOf(Class<? extends Structure> clazz)
Checks that the runtime type name matches the type name from the binding
class.
|
static Error |
_newInstance(StructValue structValue)
WARNING: Internal API, subject to change in future versions.
Returns new instance of this binding class and injects the provided data value. WARNING: The returned object is not fully initialized. |
void |
_setDynamicField(String fieldName,
DataValue fieldValue)
Sets a dynamic field value.
|
void |
_validate()
Validates the state of the discriminated unions and HasFieldsOf
restrictions (if any) in this Java language binding
Structure . |
boolean |
equals(Object obj) |
Structure |
getData()
Data to facilitate clients responding to the method reporting a standard
exception to indicating that it was unable to complete successfully.
|
String |
getMessage() |
List<LocalizableMessage> |
getMessages()
Stack of one or more localizable messages for human exception consumers.
|
int |
hashCode() |
void |
setData(Structure data)
Data to facilitate clients responding to the method reporting a standard
exception to indicating that it was unable to complete successfully.
|
void |
setMessages(List<LocalizableMessage> messages)
Stack of one or more localizable messages for human exception consumers.
|
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
toString
public Error(List<LocalizableMessage> messages, Structure data)
public Error()
public List<LocalizableMessage> getMessages()
The message at the top of the stack (first in the list) describes the exception from the perspective of the method the client invoked. Each subsequent message in the stack describes the "cause" of the prior message.
public void setMessages(List<LocalizableMessage> messages)
The message at the top of the stack (first in the list) describes the exception from the perspective of the method the client invoked. Each subsequent message in the stack describes the "cause" of the prior message.
messages
- New value for the property.public Structure getData()
Methods may provide data that clients can use when responding to exceptions.
Since the data that clients need may be specific to the context of the method
reporting the exception, different methods that report the same exception may
provide different data in the exception. The documentation for each each method
will describe what, if any, data it provides for each exception it reports. The
ArgumentLocations
, FileLocations
, and TransientIndication
classes are intended as possible
values for this property. DynamicID
may also be
useful as a value for this property (although that is not its primary purpose).
Some interfaces may provide their own specific classes for use as the value of
this property when reporting exceptions from their methods.
public void setData(Structure data)
Methods may provide data that clients can use when responding to exceptions.
Since the data that clients need may be specific to the context of the method
reporting the exception, different methods that report the same exception may
provide different data in the exception. The documentation for each each method
will describe what, if any, data it provides for each exception it reports. The
ArgumentLocations
, FileLocations
, and TransientIndication
classes are intended as possible
values for this property. DynamicID
may also be
useful as a value for this property (although that is not its primary purpose).
Some interfaces may provide their own specific classes for use as the value of
this property when reporting exceptions from their methods.
data
- New value for the property.public com.vmware.vapi.bindings.type.ErrorType _getType()
StaticStructure
StructType
instance representing the static bindings
type for this Structure
._getType
in interface StaticStructure
StructType
public StructValue _getDataValue()
Structure
Structure
represented in the dynamic
DataValue
model.
Attempts to change the returned StructValue
representation are not required to change the state of this structure.
Actually the behavior is implementation dependent and is unspecified.
In general the returned value shouldn't be changed.
_getDataValue
in interface Structure
StructValue
representing this structurepublic void _validate()
StaticStructure
Structure
.
More precisely, for each union: given value of the discriminant/tag
field (@UnionTag
in the IDL) of an union in this structure,
validates that:
_validate
in interface StaticStructure
public String getMessage()
getMessage
in class Throwable
public boolean _hasTypeNameOf(Class<? extends Structure> clazz)
Structure
_hasTypeNameOf
in interface Structure
clazz
- type of the result structure. cannot be null.public <T extends Structure> T _convertTo(Class<T> clazz)
Structure
_convertTo
in interface Structure
clazz
- type of the result structure. cannot be null.CoreException
is thrown otherwise.public void _setDynamicField(String fieldName, DataValue fieldValue)
StaticStructure
_setDynamicField
in interface StaticStructure
fieldName
- canonical name of the dynamic field to setfieldValue
- the value of the fieldpublic DataValue _getDynamicField(String fieldName)
StaticStructure
_getDynamicField
in interface StaticStructure
fieldName
- the canonical name of the dynamic fieldDataValue
of the dynamic fieldpublic Set<String> _getDynamicFieldNames()
StaticStructure
_getDynamicFieldNames
in interface StaticStructure
public static com.vmware.vapi.bindings.type.ErrorType _getClassType()
ErrorType
instance representing the static bindings
type for this Error
.public String _getCanonicalName()
Structure
org.example.FooBar
would turn into
org.example.foo_bar
._getCanonicalName
in interface Structure
public static String _getCanonicalTypeName()
_getCanonicalName()
.public static Error _newInstance(StructValue structValue)
structValue
- the source of the data contained in the binding object. Could
contain more data than fields of this class can describe i.e.
newer version of the binding object. Could be null.StructType
Copyright © 2016. All Rights Reserved.