Package com.azure.core.util.serializer
Enum CollectionFormat
- All Implemented Interfaces:
Serializable
,Comparable<CollectionFormat>
,java.lang.constant.Constable
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.-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
-
Method Summary
Modifier and TypeMethodDescriptionGets the delimiter used to join a list of parameters.static CollectionFormat
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.
-
Enum Constant Details
-
CSV
Comma separated values. E.g. foo,bar -
SSV
Space separated values. E.g. foo bar -
TSV
Tab separated values. E.g. foo\tbar -
PIPES
Pipe(|) separated values. E.g. foo|bar -
MULTI
Corresponds to multiple parameter instances instead of multiple values for a single instance. E.g. foo=bar&foo=baz
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
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 nameNullPointerException
- if the argument is null
-
getDelimiter
Gets the delimiter used to join a list of parameters.- Returns:
- the delimiter of the current collection format.
-