Package org.opendaylight.yangtools.yang.common

Interface YangError

  • All Known Implementing Classes:
    YangInvalidValueException
    @Beta
@Deprecated(forRemoval=true,
            since="7.0.4")
public interface YangError
    Deprecated, for removal: This API element is subject to removal in a future version.
    This interface is not completely sufficient to describe errors, as it lacks the ability to carry instance path as well as more-info elements.
    An error condition raised as a consequence of a YANG-defined contract. This interface should not be directly implemented, but rather should be attached to a well-defined Exception class.

    • Method Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method Description
      Optional<String> getErrorAppTag()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the value of the argument of YANG error-app-tag statement.
      Optional<String> getErrorMessage()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the value of the argument of YANG error-message statement.
      @NonNull String getErrorTag()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the error tag, as determined by the application reporting the error.
      @NonNull RpcError.ErrorType getErrorType()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the conceptual layer at which the error occurred.
      @NonNull RpcError.ErrorSeverity getSeverity()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the error severity, as determined by the application reporting the error.

    • Method Detail

      • getErrorType

        @NonNull RpcError.ErrorType getErrorType()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Returns the conceptual layer at which the error occurred.
        Returns:
        an RpcError.ErrorType enum.

      • getSeverity

        @NonNull RpcError.ErrorSeverity getSeverity()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Returns the error severity, as determined by the application reporting the error.
        Returns:
        an RpcError.ErrorSeverity enum.

      • getErrorTag

        @NonNull String getErrorTag()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Returns the error tag, as determined by the application reporting the error.
        Returns:
        an error tag.

      • getErrorAppTag

        Optional<String> getErrorAppTag()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Returns the value of the argument of YANG error-app-tag statement.
        Returns:
        string with the application error tag, or empty if it was not provided.

      • getErrorMessage

        Optional<String> getErrorMessage()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Returns the value of the argument of YANG error-message statement.
        Returns:
        string with the error message, or empty if it was not provided.