io.dropwizard.jersey.params

Class DurationParam

java.lang.Object

io.dropwizard.jersey.params.AbstractParam<io.dropwizard.util.Duration>

io.dropwizard.jersey.params.DurationParam

public class DurationParam
extends AbstractParam<io.dropwizard.util.Duration>

A parameter encapsulating duration values. All non-parsable values will return a 400 Bad Request response. Supports all input formats the Duration class supports.

Constructor Summary

Constructors

Constructor and Description
DurationParam(String input)
DurationParam(String input, String parameterName)

Method Summary

Modifier and Type	Method and Description
protected String	errorMessage(Exception e) Given a string representation which was unable to be parsed and the exception thrown, produce an entity to be sent to the client.
protected io.dropwizard.util.Duration	parse(String input) Given a string representation, parse it and return an instance of the parameter type.

Methods inherited from class io.dropwizard.jersey.params.AbstractParam

equals, error, get, getErrorStatus, hashCode, mediaType, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DurationParam

public DurationParam(@Nullable
                     String input)

DurationParam

public DurationParam(@Nullable
                     String input,
                     String parameterName)

Method Detail

errorMessage

protected String errorMessage(Exception e)

Description copied from class: AbstractParam

Given a string representation which was unable to be parsed and the exception thrown, produce an entity to be sent to the client.

Overrides:

errorMessage in class AbstractParam<io.dropwizard.util.Duration>

Parameters:

e - the exception thrown while parsing input

Returns:

the error message to be sent the client

parse

protected io.dropwizard.util.Duration parse(@Nullable
                                            String input)
                                     throws Exception

Description copied from class: AbstractParam

Given a string representation, parse it and return an instance of the parameter type.

Specified by:

parse in class AbstractParam<io.dropwizard.util.Duration>

Parameters:

input - the raw input

Returns:

input, parsed as an instance of T

Throws:

Exception - if there is an error parsing the input