Package org.eclipse.ditto.json

Interface JsonException

All Known Implementing Classes:
JsonFieldSelectorInvalidException, JsonKeyInvalidException, JsonMissingFieldException, JsonParseException, JsonPointerInvalidException, JsonRuntimeException
public interface JsonException
The methods of this interface are common for all JSON related exceptions.

  • Method Summary

    Modifier and Type
    Method
    Description
    default Optional<String>
    getDescription()
    Returns the description which should be reported to the user.
    String
    getErrorCode()
    Returns the error code to uniquely identify this exception.
    default Optional<URI>
    getHref()
    Returns a link with which the user can find further information regarding this exception.

  • Method Details

    • getErrorCode

      String getErrorCode()
      Returns the error code to uniquely identify this exception.
      Returns:
      the error code.

    • getDescription

      default Optional<String> getDescription()
      Returns the description which should be reported to the user.
      Returns:
      the description.

    • getHref

      default Optional<URI> getHref()
      Returns a link with which the user can find further information regarding this exception.
      Returns:
      a link to provide the user with further information about this exception.