abstract class StringCollectionExtractor extends java.lang.Object implements MultivaluedParameterExtractor<java.util.Collection<java.lang.String>>
String
Java collection type.
This class can be seen as a special, optimized, case of CollectionExtractor
.Modifier and Type | Class and Description |
---|---|
private static class |
StringCollectionExtractor.ListString |
private static class |
StringCollectionExtractor.SetString |
private static class |
StringCollectionExtractor.SortedSetString |
Modifier and Type | Field and Description |
---|---|
private java.lang.String |
defaultValue |
private java.lang.String |
parameter |
Modifier | Constructor and Description |
---|---|
protected |
StringCollectionExtractor(java.lang.String parameterName,
java.lang.String defaultValue)
Create new string collection parameter extractor.
|
Modifier and Type | Method and Description |
---|---|
java.util.Collection<java.lang.String> |
extract(javax.ws.rs.core.MultivaluedMap<java.lang.String,java.lang.String> parameters)
Extract the map entry identified by a
name (and using
the configured default value ) from
the supplied multivalued map . |
java.lang.String |
getDefaultValueString()
Default entry value (string) that will be used in case the entry
is not present in the supplied
multivalued map . |
static StringCollectionExtractor |
getInstance(java.lang.Class<?> collectionType,
java.lang.String parameterName,
java.lang.String defaultValue)
Get string collection extractor instance supporting the given collection
class type for the parameter specified.
|
java.lang.String |
getName()
Name of the parameter (map key) to be extracted from the supplied
multivalued map . |
protected abstract java.util.Collection<java.lang.String> |
newCollection()
Get a new string collection instance that will be used to store the extracted parameters.
|
private final java.lang.String parameter
private final java.lang.String defaultValue
protected StringCollectionExtractor(java.lang.String parameterName, java.lang.String defaultValue)
parameterName
- parameter name.defaultValue
- default parameter value.public java.lang.String getName()
MultivaluedParameterExtractor
multivalued map
.getName
in interface MultivaluedParameterExtractor<java.util.Collection<java.lang.String>>
public java.lang.String getDefaultValueString()
MultivaluedParameterExtractor
multivalued map
.getDefaultValueString
in interface MultivaluedParameterExtractor<java.util.Collection<java.lang.String>>
public java.util.Collection<java.lang.String> extract(javax.ws.rs.core.MultivaluedMap<java.lang.String,java.lang.String> parameters)
MultivaluedParameterExtractor
name
(and using
the configured default value
) from
the supplied multivalued map
.extract
in interface MultivaluedParameterExtractor<java.util.Collection<java.lang.String>>
parameters
- multivalued parameter map.protected abstract java.util.Collection<java.lang.String> newCollection()
public static StringCollectionExtractor getInstance(java.lang.Class<?> collectionType, java.lang.String parameterName, java.lang.String defaultValue)
collectionType
- collection type to be supported by the extractor.parameterName
- extracted parameter name.defaultValue
- default parameter value.