io.dropwizard.jersey.params

Class DateTimeParam

java.lang.Object

io.dropwizard.jersey.params.AbstractParam<org.joda.time.DateTime>

io.dropwizard.jersey.params.DateTimeParam

public class DateTimeParam
extends AbstractParam<org.joda.time.DateTime>

A parameter encapsulating date/time values. All non-parsable values will return a 400 Bad Request response. All values returned are in UTC.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected org.joda.time.DateTime	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, errorMessage, get, getErrorStatus, hashCode, mediaType, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

DateTimeParam

public DateTimeParam(@Nullable
                     String input)

DateTimeParam

public DateTimeParam(@Nullable
                     String input,
                     String parameterName)

Method Detail

parse

protected org.joda.time.DateTime 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<org.joda.time.DateTime>

Parameters:

input - the raw input

Returns:

input, parsed as an instance of T

Throws:

Exception - if there is an error parsing the input