org.glassfish.jersey.server.internal.inject

Interface MultivaluedParameterExtractor<T>

public interface MultivaluedParameterExtractor<T>

Provider that converts the values of an entry of a given name from the supplied multivalued map into an object of a custom Java type.

Author:

Paul Sandoz, Marek Potociar (marek.potociar at oracle.com)

Method Summary

Methods

Modifier and Type	Method and Description
T	extract(MultivaluedMap<String,String> multimap) Extract the map entry identified by a name (and using the configured default value) from the supplied multivalued map.
String	getDefaultValueString() Default entry value (string) that will be used in case the entry is not present in the supplied multivalued map.
String	getName() Name of the parameter (map key) to be extracted from the supplied multivalued map.

Method Detail

getName

String getName()

Name of the parameter (map key) to be extracted from the supplied multivalued map.

Returns:

name of the extracted parameter.

getDefaultValueString

String getDefaultValueString()

Default entry value (string) that will be used in case the entry is not present in the supplied multivalued map.

Returns:

default (back-up) map entry value.

extract

T extract(MultivaluedMap<String,String> multimap)

Extract the map entry identified by a name (and using the configured default value) from the supplied multivalued map.

Parameters:

multimap - multivalued parameter map.

Returns:

custom Java type instance representing the extracted multivalued map entry.