Enum CollectionFormat

java.lang.Object
java.lang.Enum<CollectionFormat>
com.azure.core.util.serializer.CollectionFormat
All Implemented Interfaces:
Serializable, Comparable<CollectionFormat>, java.lang.constant.Constable

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 Details

    • 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 Details

    • values

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

      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.