Enum 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 joining List parameters in paths, queries, and headers.
    • 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

      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.
      • 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
    • 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 name
        java.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.