public final Enum QueryParamStyle

Class Inheritance

java.lang.Object
java.lang.Enum
org.eclipse.microprofile.rest.client.ext.QueryParamStyle

A QueryParamStyle enum is used to specify how multiple values are handled when constructing the query portion of the URI. For example, a client interface may take a collection of strings as it's query parameter. This enum determines the style:

public interface MultiParamClient {
    void sendMultipleQueryParams(@QueryParam("foo") List<String> strings);
}

The style selected when building this client instance will determine the format of the query portion of the URI.

Since: 2.0

Field Summary

Modifier and Type	Field and Description
public static final QueryParamStyle	ARRAY_PAIRS Multiple parameter instances with square brackets for each parameter, e.g.: `foo[]=v1&foo[]=v2&foo[]=v3`
public static final QueryParamStyle	COMMA_SEPARATED A single parameter instance with multiple, comma-separated values, e.g.: `foo=v1,v2,v3`
public static final QueryParamStyle	MULTI_PAIRS Multiple parameter instances, e.g.: `foo=v1&foot=v2&foo=v3` This is the default if no style is configured.

Constructor Summary

Access	Constructor and Description
private	QueryParamStyle()

Method Summary

Modifier and Type	Method and Description
public static QueryParamStyle	valueOf(String name)
public static QueryParamStyle[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

ARRAY_PAIRS	back to summary
public static final QueryParamStyle ARRAY_PAIRS Multiple parameter instances with square brackets for each parameter, e.g.: `foo[]=v1&foo[]=v2&foo[]=v3`

COMMA_SEPARATED	back to summary
public static final QueryParamStyle COMMA_SEPARATED A single parameter instance with multiple, comma-separated values, e.g.: `foo=v1,v2,v3`

MULTI_PAIRS	back to summary
public static final QueryParamStyle MULTI_PAIRS Multiple parameter instances, e.g.: `foo=v1&foot=v2&foo=v3` This is the default if no style is configured.

Constructor Detail

QueryParamStyle	back to summary
private QueryParamStyle()

Method Detail

valueOf	back to summary
public static QueryParamStyle valueOf(String name)

values	back to summary
public static QueryParamStyle[] values()