Enum CollectionFormatType

  • All Implemented Interfaces:
    Serializable, Comparable<CollectionFormatType>

    public enum CollectionFormatType
    extends Enum<CollectionFormatType>
    For list collections that we send in the query string, describes the different ways we can encode it in the query string.

    Values and meanings align with the different collectionFormat values in Swagger. Each of the *Separated enum members describes a different delimiter character, whereas the Multi value means that each collection member will appear as a separate entry in the query string of the form =.

    • Method Detail

      • values

        public static CollectionFormatType[] 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 (CollectionFormatType c : CollectionFormatType.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

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