org.glassfish.jersey.server.internal.inject.CollectionExtractor Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jaxrs-ri Show documentation
Show all versions of jaxrs-ri Show documentation
A bundle project producing JAX-RS RI bundles. The primary artifact is an "all-in-one" OSGi-fied JAX-RS RI bundle
(jaxrs-ri.jar).
Attached to that are two compressed JAX-RS RI archives. The first archive (jaxrs-ri.zip) consists of binary RI bits and
contains the API jar (under "api" directory), RI libraries (under "lib" directory) as well as all external
RI dependencies (under "ext" directory). The secondary archive (jaxrs-ri-src.zip) contains buildable JAX-RS RI source
bundle and contains the API jar (under "api" directory), RI sources (under "src" directory) as well as all external
RI dependencies (under "ext" directory). The second archive also contains "build.xml" ANT script that builds the RI
sources. To build the JAX-RS RI simply unzip the archive, cd to the created jaxrs-ri directory and invoke "ant" from
the command line.
/*
* Copyright (c) 2010, 2020 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception, which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
package org.glassfish.jersey.server.internal.inject;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import java.util.SortedSet;
import java.util.TreeSet;
import jakarta.ws.rs.ProcessingException;
import jakarta.ws.rs.core.MultivaluedMap;
import jakarta.ws.rs.ext.ParamConverter;
import org.glassfish.jersey.server.internal.LocalizationMessages;
/**
* Extract parameter value as a typed collection.
*
* @param parameter value type.
* @author Paul Sandoz
* @author Marek Potociar
*/
abstract class CollectionExtractor extends AbstractParamValueExtractor
implements MultivaluedParameterExtractor> {
/**
* Create new collection parameter extractor.
*
* @param converter parameter converter to be used to convert parameter from a String.
* @param parameterName parameter name.
* @param defaultStringValue default parameter String value.
*/
protected CollectionExtractor(final ParamConverter converter,
final String parameterName,
final String defaultStringValue) {
super(converter, parameterName, defaultStringValue);
}
@Override
@SuppressWarnings("unchecked")
public Collection extract(final MultivaluedMap parameters) {
final List stringList = parameters.get(getName());
final Collection valueList = newCollection();
if (stringList != null) {
for (final String v : stringList) {
valueList.add(fromString(v));
}
} else if (isDefaultValueRegistered()) {
valueList.add(defaultValue());
}
return valueList;
}
/**
* 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.
*
* @return instance of a proper collection sub-type
*/
protected abstract Collection newCollection();
private static final class ListValueOf extends CollectionExtractor {
ListValueOf(final ParamConverter converter, final String parameter, final String defaultValueString) {
super(converter, parameter, defaultValueString);
}
@Override
protected List newCollection() {
return new ArrayList<>();
}
}
private static final class SetValueOf extends CollectionExtractor {
SetValueOf(final ParamConverter converter, final String parameter, final String defaultValueString) {
super(converter, parameter, defaultValueString);
}
@Override
protected Set newCollection() {
return new HashSet<>();
}
}
private static final class SortedSetValueOf extends CollectionExtractor {
SortedSetValueOf(final ParamConverter converter, final String parameter, final String defaultValueString) {
super(converter, parameter, defaultValueString);
}
@Override
protected SortedSet newCollection() {
return new TreeSet<>();
}
}
/**
* Get a new {@code CollectionExtractor} instance.
*
* @param collectionType raw collection type.
* @param converter parameter converter to be used to convert parameter string values into
* values of the requested Java type.
* @param parameterName parameter name.
* @param defaultValueString default parameter string value.
* @param converted parameter Java type.
* @return new collection parameter extractor instance.
*/
public static CollectionExtractor getInstance(final Class collectionType,
final ParamConverter converter,
final String parameterName,
final String defaultValueString) {
if (List.class == collectionType) {
return new ListValueOf<>(converter, parameterName, defaultValueString);
} else if (Set.class == collectionType) {
return new SetValueOf<>(converter, parameterName, defaultValueString);
} else if (SortedSet.class == collectionType) {
return new SortedSetValueOf<>(converter, parameterName, defaultValueString);
} else {
throw new ProcessingException(LocalizationMessages.COLLECTION_EXTRACTOR_TYPE_UNSUPPORTED());
}
}
}