Enum SerdeCollectionFormat
- java.lang.Object
-
- java.lang.Enum<SerdeCollectionFormat>
-
- com.azure.android.core.serde.jackson.SerdeCollectionFormat
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<SerdeCollectionFormat>
public enum SerdeCollectionFormat extends java.lang.Enum<SerdeCollectionFormat>
Swagger collection format to use for joiningList
parameters in paths, queries, and headers.
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getDelimiter()
Gets the delimiter used to join a list of parameters.static SerdeCollectionFormat
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static SerdeCollectionFormat[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
CSV
public static final SerdeCollectionFormat CSV
Comma separated values. E.g. foo,bar
-
SSV
public static final SerdeCollectionFormat SSV
Space separated values. E.g. foo bar
-
TSV
public static final SerdeCollectionFormat TSV
Tab separated values. E.g. foo\tbar
-
PIPES
public static final SerdeCollectionFormat PIPES
Pipe(|) separated values. E.g. foo|bar
-
MULTI
public static final SerdeCollectionFormat 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 SerdeCollectionFormat[] 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 (SerdeCollectionFormat c : SerdeCollectionFormat.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static SerdeCollectionFormat valueOf(java.lang.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:
java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is null
-
getDelimiter
public java.lang.String getDelimiter()
Gets the delimiter used to join a list of parameters.- Returns:
- the delimiter of the current collection format.
-
-