Package com.azure.core.util.serializer

Enum CollectionFormat

java.lang.Object

java.lang.Enum<CollectionFormat>

com.azure.core.util.serializer.CollectionFormat

All Implemented Interfaces:

Serializable, Comparable<CollectionFormat>

public enum CollectionFormat
extends Enum<CollectionFormat>

Swagger collection format to use for joining List parameters in paths, queries, and headers. See https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#fixed-fields-7.

Enum Constant Summary

Enum Constants

Enum Constant	Description
CSV	Comma separated values.
MULTI	Corresponds to multiple parameter instances instead of multiple values for a single instance.
PIPES	Pipe(|) separated values.
SSV	Space separated values.
TSV	Tab separated values.

Method Summary

Modifier and Type	Method	Description
String	getDelimiter()	Gets the delimiter used to join a list of parameters.
static CollectionFormat	valueOf(String name)	Returns the enum constant of this type with the specified name.
static CollectionFormat[]	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

CSV

public static final CollectionFormat CSV

Comma separated values. E.g. foo,bar

SSV

public static final CollectionFormat SSV

Space separated values. E.g. foo bar

TSV

public static final CollectionFormat TSV

Tab separated values. E.g. foo\tbar

PIPES

public static final CollectionFormat PIPES

Pipe(|) separated values. E.g. foo|bar

MULTI

public static final CollectionFormat MULTI

Corresponds to multiple parameter instances instead of multiple values for a single instance. E.g. foo=bar&foo=baz

Method Detail

values

public static CollectionFormat[] 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 (CollectionFormat c : CollectionFormat.values())
    System.out.println(c);

Returns:

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

valueOf

public static CollectionFormat 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

getDelimiter

public String getDelimiter()

Gets the delimiter used to join a list of parameters.

Returns:

the delimiter of the current collection format.