Class ParamException

  • All Implemented Interfaces:
    java.io.Serializable
    Direct Known Subclasses:
    FormDataParamException, ParamException.CookieParamException, ParamException.FormParamException, ParamException.HeaderParamException, ParamException.UriParamException

    public abstract class ParamException
    extends javax.ws.rs.WebApplicationException
    An abstract extension of WebApplicationException for the class of parameter-based exceptions.

    Exceptions that are instances of this class will be thrown if the runtime encounters an error obtaining a parameter value, from a request, for a Java type that is annotated with a parameter-based annotation, such as QueryParam. For more details see section 3.2 of the JAX-RS specification.

    An ExceptionMapper may be configured to map this class or a sub-class of to customize responses for parameter-based errors.

    Unless otherwise stated all such exceptions of this type will contain a response with a 400 (Client error) status code.

    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.lang.String defaultStringValue  
      private java.lang.String name  
      private java.lang.Class<? extends java.lang.annotation.Annotation> parameterType  
      private static long serialVersionUID  
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected ParamException​(java.lang.Throwable cause, javax.ws.rs.core.Response.StatusType status, java.lang.Class<? extends java.lang.annotation.Annotation> parameterType, java.lang.String name, java.lang.String defaultStringValue)  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getDefaultStringValue()
      Get the default String value.
      java.lang.String getParameterName()
      Get the parameter name.
      java.lang.Class<? extends java.lang.annotation.Annotation> getParameterType()
      Get the type of the parameter annotation.
      • Methods inherited from class javax.ws.rs.WebApplicationException

        getResponse
      • Methods inherited from class java.lang.Throwable

        addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Field Detail

      • parameterType

        private final java.lang.Class<? extends java.lang.annotation.Annotation> parameterType
      • name

        private final java.lang.String name
      • defaultStringValue

        private final java.lang.String defaultStringValue
    • Constructor Detail

      • ParamException

        protected ParamException​(java.lang.Throwable cause,
                                 javax.ws.rs.core.Response.StatusType status,
                                 java.lang.Class<? extends java.lang.annotation.Annotation> parameterType,
                                 java.lang.String name,
                                 java.lang.String defaultStringValue)
    • Method Detail

      • getParameterType

        public java.lang.Class<? extends java.lang.annotation.Annotation> getParameterType()
        Get the type of the parameter annotation.
        Returns:
        the type of the parameter annotation.
      • getParameterName

        public java.lang.String getParameterName()
        Get the parameter name.
        Returns:
        the parameter name.
      • getDefaultStringValue

        public java.lang.String getDefaultStringValue()
        Get the default String value.
        Returns:
        the default String value.