1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17 package org.apache.juneau.httppart;
18
19 /**
20 * Valid values for the <c>collectionFormat</c> field.
21 *
22 * <h5 class='section'>See Also:</h5><ul>
23 * <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/HttpPartSerializersParsers">HTTP Part Serializers and Parsers</a>
24 * </ul>
25 */
26 public enum HttpPartCollectionFormat {
27
28 /**
29 * Comma-separated values (e.g. <js>"foo,bar"</js>).
30 */
31 CSV,
32
33 /**
34 * Space-separated values (e.g. <js>"foo bar"</js>).
35 */
36 SSV,
37
38 /**
39 * Tab-separated values (e.g. <js>"foo\tbar"</js>).
40 */
41 TSV,
42
43 /**
44 * Pipe-separated values (e.g. <js>"foo|bar"</js>).
45 */
46 PIPES,
47
48 /**
49 * Corresponds to multiple parameter instances instead of multiple values for a single instance (e.g. <js>"foo=bar&foo=baz"</js>).
50 */
51 MULTI,
52
53 /**
54 * UON collection notation (e.g. <js>"@(foo,bar)"</js>).
55 */
56 UONC,
57
58 /**
59 * Not specified.
60 */
61 NO_COLLECTION_FORMAT;
62
63 /**
64 * Create from lowercase string.
65 *
66 * @param value The enum name.
67 * @return The enum.
68 */
69 public static HttpPartCollectionFormat fromString(String value) {
70 if (value == null)
71 return null;
72 if (value.equalsIgnoreCase("UON"))
73 return UONC;
74 return valueOf(value.toUpperCase());
75 }
76
77 @Override /* Overridden from Object */
78 public String toString() {
79 return name().toLowerCase();
80 }
81 }