Package com.vmware.vapi.std.errors

Class Error

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Error.Builder
      Builder class for Error.
      static class  Error.Type
      Enumeration of all standard errors.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      <T extends Structure>
      T      		 _convertTo​(java.lang.Class<T> clazz)
      Converts this structure into an instance of the provided class structure if possible.
      java.lang.String _getCanonicalName()
      Returns the canonical name of the structure.
      static java.lang.String _getCanonicalTypeName()
      Returns the canonical type name.
      static com.vmware.vapi.bindings.type.ErrorType _getClassType()
      WARNING: Internal method, subject to change in future versions.
      StructValue _getDataValue()
      Returns this Structure represented in the dynamic DataValue model.
      DataValue _getDynamicField​(java.lang.String fieldName)
      Get a dynamic field value, doesn't allow access to static fields (which have getters/setters).
      java.util.Set<java.lang.String> _getDynamicFieldNames()
      Get the names of the dynamic fields in the structure.
      com.vmware.vapi.bindings.type.ErrorType _getType()
      WARNING: Internal method, subject to change in future versions.
      boolean _hasTypeNameOf​(java.lang.Class<? extends Structure> clazz)
      Checks if the runtime type name of this structure matches the type represented by the specified binding class.
      static Error _newInstance​(StructValue structValue)
      WARNING: Internal method, 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.
      static Error _newInstance2​(StructValue structValue)
      WARNING: Internal method, subject to change in future versions.
      Serves as a versioning mechanism.
      void _setDynamicField​(java.lang.String fieldName, DataValue fieldValue)
      Sets a dynamic field value.
      protected void _updateDataValue​(StructValue structValue)  
      void _validate()
      Validates the state of the discriminated unions and HasFieldsOf restrictions (if any) in this Java language binding Structure.
      boolean equals​(java.lang.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.
      Error.Type getErrorType()
      Discriminator field to help API consumers identify the structure type.
      java.lang.String getMessage()  
      java.util.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​(java.util.List<LocalizableMessage> messages)
      Stack of one or more localizable messages for human exception consumers.

      • Methods inherited from class java.lang.Throwable

        addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    • Field Detail

      • __dynamicStructureFields

        protected StructValue __dynamicStructureFields

    • Constructor Detail

      • Error

        public Error​(java.util.List<LocalizableMessage> messages,
             Structure data)
        This constructor is provided for backwards compatibility purposes only. Please use the Builder class instead.

      • Error

        public Error()
        Default constructor.

      • Error

        protected Error​(StructValue __dynamicStructureFields)

    • Method Detail

      • getMessages

        public java.util.List<LocalizableMessage> getMessages()
        Stack of one or more localizable messages for human exception consumers.

        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.

        Returns:
        The current value of the property.

      • setMessages

        public void setMessages​(java.util.List<LocalizableMessage> messages)
        Stack of one or more localizable messages for human exception consumers.

        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.

        Parameters:
        messages - New value for the property.

      • getData

        public Structure getData()
        Data to facilitate clients responding to the method reporting a standard exception to indicating that it was unable to complete successfully.

        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.

        Some methods will not set this property when reporting exceptions.
        Returns:
        The current value of the property.

      • setData

        public 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.

        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.

        Some methods will not set this property when reporting exceptions.
        Parameters:
        data - New value for the property.

      • getErrorType

        public Error.Type getErrorType()
        Discriminator field to help API consumers identify the structure type. The value of this property is automatically populated. Can be null for compatibility with preceding implementations.
        Returns:
        The current value of the property.

      • _getType

        public com.vmware.vapi.bindings.type.ErrorType _getType()
        Description copied from interface: StaticStructure
        WARNING: Internal method, subject to change in future versions. Returns StructType instance representing the static bindings type for this Structure.
        Specified by:
        _getType in interface StaticStructure
        Returns:
        the static bindings StructType

      • _getDataValue

        public StructValue _getDataValue()
        Description copied from interface: Structure
        Returns this 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.

        Specified by:
        _getDataValue in interface Structure
        Returns:
        StructValue representing this structure

      • _updateDataValue

        protected void _updateDataValue​(StructValue structValue)

      • _validate

        public void _validate()
        Description copied from interface: StaticStructure
        Validates the state of the discriminated unions and HasFieldsOf restrictions (if any) in this Java language binding 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:

      • all fields of the union required for that value of the discriminant are set
      • fields of the union that are not allowed for that value of the discriminant are not set
      • any other fields of the structure (not participating in the union) do not affect the validation result
Specified by:
_validate in interface StaticStructure