io.dropwizard.jersey.params.DurationParam Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dropwizard-jersey Show documentation

There is a newer version: 5.0.0-rc.1

package io.dropwizard.jersey.params;

import io.dropwizard.util.Duration;

import javax.annotation.Nullable;

import static java.util.Objects.requireNonNull;

/**
 * A parameter encapsulating duration values. All non-parsable values will return a {@code 400 Bad
 * Request} response. Supports all input formats the {@link Duration} class supports.
 *
 * @deprecated As of release 2.0.0, will be removed in 3.0.0. Please use {@link java.util.Optional} instead.
 */
@Deprecated
public class DurationParam extends AbstractParam {

    public DurationParam(@Nullable String input) {
        super(input);
    }

    public DurationParam(@Nullable String input, String parameterName) {
        super(input, parameterName);
    }

    @Override
    protected String errorMessage(Exception e) {
        return "%s is not a valid duration.";
    }

    @Override
    protected Duration parse(@Nullable String input) throws Exception {
        return Duration.parse(requireNonNull(input));
    }

}