org.glassfish.jersey.uri

Enum JerseyQueryParamStyle

java.lang.Object

java.lang.Enum<JerseyQueryParamStyle>

org.glassfish.jersey.uri.JerseyQueryParamStyle

All Implemented Interfaces:

Serializable, Comparable<JerseyQueryParamStyle>

public enum JerseyQueryParamStyle
extends Enum<JerseyQueryParamStyle>

JerseyQueryParamStyle is used to specify the desired format of query param when multiple values are sent for the same parameter.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ARRAY_PAIRS Multiple parameter instances with square brackets for each parameter, e.g.: foo[]=v1&foo[]=v2&foo[]=v3
COMMA_SEPARATED A single parameter instance with multiple, comma-separated values, e.g.: foo=v1,v2,v3
MULTI_PAIRS Multiple parameter instances, e.g.: foo=v1&foo=v2&foo=v3 This is the default query format.

Method Summary

Modifier and Type	Method and Description
static JerseyQueryParamStyle	valueOf(String name) Returns the enum constant of this type with the specified name.
static JerseyQueryParamStyle[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

MULTI_PAIRS

public static final JerseyQueryParamStyle MULTI_PAIRS

Multiple parameter instances, e.g.: foo=v1&foo=v2&foo=v3 This is the default query format.

COMMA_SEPARATED

public static final JerseyQueryParamStyle COMMA_SEPARATED

A single parameter instance with multiple, comma-separated values, e.g.: foo=v1,v2,v3

ARRAY_PAIRS

public static final JerseyQueryParamStyle ARRAY_PAIRS

Multiple parameter instances with square brackets for each parameter, e.g.: foo[]=v1&foo[]=v2&foo[]=v3

Method Detail

values

public static JerseyQueryParamStyle[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (JerseyQueryParamStyle c : JerseyQueryParamStyle.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static JerseyQueryParamStyle valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null