public abstract class ParamException extends WebApplicationException
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.
Modifier and Type | Class and Description |
---|---|
static class |
ParamException.CookieParamException
A parameter exception for errors with
CookieParam . |
static class |
ParamException.FormParamException
A parameter exception for errors with
FormParam . |
static class |
ParamException.HeaderParamException
A parameter exception for errors with
HeaderParam . |
static class |
ParamException.MatrixParamException
A URI-parameter-based exception for errors with
MatrixParam . |
static class |
ParamException.PathParamException
A URI-parameter-based exception for errors with
PathParam . |
static class |
ParamException.QueryParamException
A URI-parameter-based exception for errors with
QueryParam . |
static class |
ParamException.UriParamException
An abstract parameter exception for the class of URI-parameter-based
exceptions.
|
Modifier | Constructor and Description |
---|---|
protected |
ParamException(Throwable cause,
Response.StatusType status,
Class<? extends Annotation> parameterType,
String name,
String defaultStringValue) |
Modifier and Type | Method and Description |
---|---|
String |
getDefaultStringValue()
Get the default String value.
|
String |
getParameterName()
Get the parameter name.
|
Class<? extends Annotation> |
getParameterType()
Get the type of the parameter annotation.
|
getResponse
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
protected ParamException(Throwable cause, Response.StatusType status, Class<? extends Annotation> parameterType, String name, String defaultStringValue)
public Class<? extends Annotation> getParameterType()
public String getParameterName()
public String getDefaultStringValue()
Copyright © 2007-2023, Oracle and/or its affiliates. All Rights Reserved. Use is subject to license terms.