io.dropwizard.jersey.params

Class NonEmptyStringParam

java.lang.Object

io.dropwizard.jersey.params.AbstractParam<Optional<String>>

io.dropwizard.jersey.params.NonEmptyStringParam

public class NonEmptyStringParam
extends AbstractParam<Optional<String>>

A parameter encapsulating optional string values with the condition that empty string inputs are interpreted as being absent. This class is useful when it is desired for empty parameters to be synonymous with absent parameters instead of empty parameters evaluating to Optional.of("").

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected Optional<String>	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

NonEmptyStringParam

public NonEmptyStringParam(@Nullable
                           String input)

NonEmptyStringParam

public NonEmptyStringParam(@Nullable
                           String input,
                           String parameterName)

Method Detail

parse

protected Optional<String> parse(@Nullable
                                 String input)

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<Optional<String>>

Parameters:

input - the raw input

Returns:

input, parsed as an instance of T