Class CollectionExtractor<T>
- java.lang.Object
-
- org.glassfish.jersey.server.internal.inject.AbstractParamValueExtractor<T>
-
- org.glassfish.jersey.server.internal.inject.CollectionExtractor<T>
-
- Type Parameters:
T
- parameter value type.
- All Implemented Interfaces:
MultivaluedParameterExtractor<java.util.Collection<T>>
- Direct Known Subclasses:
CollectionExtractor.ListValueOf
,CollectionExtractor.SetValueOf
,CollectionExtractor.SortedSetValueOf
abstract class CollectionExtractor<T> extends AbstractParamValueExtractor<T> implements MultivaluedParameterExtractor<java.util.Collection<T>>
Extract parameter value as a typed collection.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description private static class
CollectionExtractor.ListValueOf<T>
private static class
CollectionExtractor.SetValueOf<T>
private static class
CollectionExtractor.SortedSetValueOf<T>
-
Constructor Summary
Constructors Modifier Constructor Description protected
CollectionExtractor(javax.ws.rs.ext.ParamConverter<T> converter, java.lang.String parameterName, java.lang.String defaultStringValue)
Create new collection parameter extractor.
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description java.util.Collection<T>
extract(javax.ws.rs.core.MultivaluedMap<java.lang.String,java.lang.String> parameters)
Extract the map entry identified by aname
(and using the configureddefault value
) from the suppliedmultivalued map
.static <T> CollectionExtractor
getInstance(java.lang.Class<?> collectionType, javax.ws.rs.ext.ParamConverter<T> converter, java.lang.String parameterName, java.lang.String defaultValueString)
Get a newCollectionExtractor
instance.protected abstract java.util.Collection<T>
newCollection()
Get a new collection instance that will be used to store the extracted parameters.-
Methods inherited from class org.glassfish.jersey.server.internal.inject.AbstractParamValueExtractor
defaultValue, fromString, getDefaultValueString, getName, isDefaultValueRegistered
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.glassfish.jersey.server.internal.inject.MultivaluedParameterExtractor
getDefaultValueString, getName
-
-
-
-
Constructor Detail
-
CollectionExtractor
protected CollectionExtractor(javax.ws.rs.ext.ParamConverter<T> converter, java.lang.String parameterName, java.lang.String defaultStringValue)
Create new collection parameter extractor.- Parameters:
converter
- parameter converter to be used to convert parameter from a String.parameterName
- parameter name.defaultStringValue
- default parameter String value.
-
-
Method Detail
-
extract
public java.util.Collection<T> extract(javax.ws.rs.core.MultivaluedMap<java.lang.String,java.lang.String> parameters)
Description copied from interface:MultivaluedParameterExtractor
Extract the map entry identified by aname
(and using the configureddefault value
) from the suppliedmultivalued map
.- Specified by:
extract
in interfaceMultivaluedParameterExtractor<T>
- Parameters:
parameters
- multivalued parameter map.- Returns:
- custom Java type instance representing the extracted multivalued map entry.
-
newCollection
protected abstract java.util.Collection<T> newCollection()
Get a new collection instance that will be used to store the extracted parameters. The method is overridden by concrete implementations to return an instance of a proper collection sub-type.- Returns:
- instance of a proper collection sub-type
-
getInstance
public static <T> CollectionExtractor getInstance(java.lang.Class<?> collectionType, javax.ws.rs.ext.ParamConverter<T> converter, java.lang.String parameterName, java.lang.String defaultValueString)
Get a newCollectionExtractor
instance.- Type Parameters:
T
- converted parameter Java type.- Parameters:
collectionType
- raw collection type.converter
- parameter converter to be used to convert parameter string values into values of the requested Java type.parameterName
- parameter name.defaultValueString
- default parameter string value.- Returns:
- new collection parameter extractor instance.
-
-