Package io.dropwizard.jersey.params
Class AbstractParam<T>
- java.lang.Object
-
- io.dropwizard.jersey.params.AbstractParam<T>
-
- Type Parameters:
T
- the type of value wrapped by the parameter
- Direct Known Subclasses:
InstantParam
,InstantSecondParam
,IntParam
,LocalDateParam
,LocalDateTimeParam
,LocalTimeParam
,LongParam
,NonEmptyStringParam
,OffsetDateTimeParam
,UUIDParam
,YearMonthParam
,YearParam
,ZonedDateTimeParam
,ZoneIdParam
public abstract class AbstractParam<T> extends Object
An abstract base class from which to build Jersey parameter classes.
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
AbstractParam(@Nullable String input)
Given an input value from a client, creates a parameter wrapping its parsed value.protected
AbstractParam(@Nullable String input, String parameterName)
Given an input value from a client, creates a parameter wrapping its parsed value.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods Modifier and Type Method Description boolean
equals(Object obj)
protected @Nullable javax.ws.rs.core.Response
error(@Nullable String input, Exception e)
Deprecated.instead of returning aResponse
from this method, subclasses should overrideerrorMessage(java.lang.Exception)
andgetErrorStatus()
to allow aWebApplicationException
to be thrown which is mapped to a response using the exception mappers.protected String
errorMessage(Exception e)
Given a string representation which was unable to be parsed and the exception thrown, produce an error message to be sent to the client.protected ErrorMessage
generateErrorMessage(@Nullable String input, Exception e)
Generates anErrorMessage
to return to the client.T
get()
Returns the underlying value.protected javax.ws.rs.core.Response.Status
getErrorStatus()
Given a string representation which was unable to be parsed, produce aResponse.Status
for theResponse
to be sent to the client.int
hashCode()
protected javax.ws.rs.core.MediaType
mediaType()
Deprecated.the media type should be set by the exception mapper insteadprotected abstract T
parse(@Nullable String input)
Given a string representation, parse it and return an instance of the parameter type.String
toString()
-
-
-
Constructor Detail
-
AbstractParam
protected AbstractParam(@Nullable String input)
Given an input value from a client, creates a parameter wrapping its parsed value.- Parameters:
input
- an input value from a client request, might benull
-
AbstractParam
protected AbstractParam(@Nullable String input, String parameterName)
Given an input value from a client, creates a parameter wrapping its parsed value.- Parameters:
input
- an input value from a client request, might benull
parameterName
- name of the parameter with the provided value
-
-
Method Detail
-
generateErrorMessage
protected ErrorMessage generateErrorMessage(@Nullable String input, Exception e)
Generates anErrorMessage
to return to the client.- Parameters:
input
- the raw input valuee
- the exception thrown while parsinginput
- Returns:
- the
ErrorMessage
with the message and status to return to the client
-
error
@Deprecated protected @Nullable javax.ws.rs.core.Response error(@Nullable String input, Exception e)
Deprecated.instead of returning aResponse
from this method, subclasses should overrideerrorMessage(java.lang.Exception)
andgetErrorStatus()
to allow aWebApplicationException
to be thrown which is mapped to a response using the exception mappers.Deprecated - instead of throwing aWebApplicationException
that contains a response with an entity, AbstractParam now throws aWebApplicationException
that contains a message and status code, and can be mapped to a response using exception mappers. This method is kept for backwards compatibility with user-defined AbstractParam implementations that implement custom error behavior by overriding this method.Given a string representation which was unable to be parsed and the exception thrown, produce a
Response
to be sent to the client.- Parameters:
input
- the raw input valuee
- the exception thrown while parsinginput
- Returns:
- the
Response
to be sent to the client, ornull
to allow AbstractParam to throw aWebApplicationException
that contains a message and status code.
-
mediaType
@Deprecated protected javax.ws.rs.core.MediaType mediaType()
Deprecated.the media type should be set by the exception mapper insteadDeprecated - the media type should be set by the exception mapper instead. This method is no longer called by AbstractParam.- Returns:
- not used
-
errorMessage
protected String errorMessage(Exception e)
Given a string representation which was unable to be parsed and the exception thrown, produce an error message to be sent to the client.- Parameters:
e
- the exception thrown while parsinginput
- Returns:
- the error message to be sent the client
-
getErrorStatus
protected javax.ws.rs.core.Response.Status getErrorStatus()
Given a string representation which was unable to be parsed, produce aResponse.Status
for theResponse
to be sent to the client.- Returns:
- the HTTP
Response.Status
of the error message
-
parse
protected abstract T parse(@Nullable String input) throws Exception
Given a string representation, parse it and return an instance of the parameter type.- Parameters:
input
- the raw input- Returns:
input
, parsed as an instance ofT
- Throws:
Exception
- if there is an error parsing the input
-
get
public T get()
Returns the underlying value.- Returns:
- the underlying value
-
-