Class APIRuntimeException

  • All Implemented Interfaces:
    Serializable
    Direct Known Subclasses:
    APIPreconditionException

    public class APIRuntimeException
    extends RuntimeException
    Unchecked runtime exception for API related issues. Exceptions of this type will mostly be used by the internal implementation to indicate failed validations, invalid settings or unsupported character encoding.
    See Also:
    Serialized Form
    • Field Detail

      • API_PRECONDITION_ERROR

        public static final String API_PRECONDITION_ERROR
        Indicates a failed precondition check
        See Also:
        Constant Field Values
    • Constructor Detail

      • APIRuntimeException

        public APIRuntimeException​(String message)
        Creates a new unchecked API runtime exception with the given error message
        Parameters:
        message - Brief error message describing the general problem
      • APIRuntimeException

        public APIRuntimeException​(@Nonnull
                                   String message,
                                   @Nonnull
                                   String details)
        Creates a new unchecked API runtime exception with an extended error message
        Parameters:
        message - Brief error message describing the general problem. This message may contain a single %s conversion which will be automatically replaced with the given details message text.
        details - A more detailed error description
      • APIRuntimeException

        public APIRuntimeException​(String message,
                                   Exception ex)
        Creates a nested unchecked API runtime exception wrapping some other root exception
        Parameters:
        message - Brief error message describing the general problem
        ex - The original root exception