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<Collection<T>>
Direct Known Subclasses:
CollectionExtractor.ListValueOf, CollectionExtractor.SetValueOf, CollectionExtractor.SortedSetValueOf

abstract class CollectionExtractor<T> extends AbstractParamValueExtractor<T> implements MultivaluedParameterExtractor<Collection<T>>
Extract parameter value as a typed collection.
  • Constructor Details

    • CollectionExtractor

      protected CollectionExtractor(javax.ws.rs.ext.ParamConverter<T> converter, String parameterName, 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 Details

    • extract

      public Collection<T> extract(javax.ws.rs.core.MultivaluedMap<String,String> parameters)
      Description copied from interface: MultivaluedParameterExtractor
      Extract the map entry identified by a name (and using the configured default value) from the supplied multivalued map.
      Specified by:
      extract in interface MultivaluedParameterExtractor<T>
      Parameters:
      parameters - multivalued parameter map.
      Returns:
      custom Java type instance representing the extracted multivalued map entry.
    • newCollection

      protected abstract 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(Class<?> collectionType, javax.ws.rs.ext.ParamConverter<T> converter, String parameterName, String defaultValueString)
      Get a new CollectionExtractor 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.