001// ***************************************************************************************************************************
002// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  See the NOTICE file *
003// * distributed with this work for additional information regarding copyright ownership.  The ASF licenses this file        *
004// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance            *
005// * with the License.  You may obtain a copy of the License at                                                              *
006// *                                                                                                                         *
007// *  http://www.apache.org/licenses/LICENSE-2.0                                                                             *
008// *                                                                                                                         *
009// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an  *
010// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the License for the        *
011// * specific language governing permissions and limitations under the License.                                              *
012// ***************************************************************************************************************************
013package org.apache.juneau.httppart;
014
015/**
016 * Valid values for the <c>collectionFormat</c> field.
017 *
018 * <h5 class='section'>See Also:</h5><ul>
019 *    <li class='link'><a class="doclink" href="../../../../index.html#jm.HttpPartSerializersParsers">HTTP Part Serializers and Parsers</a>
020 * </ul>
021 */
022public enum HttpPartCollectionFormat {
023
024   /**
025    * Comma-separated values (e.g. <js>"foo,bar"</js>).
026    */
027   CSV,
028
029   /**
030    * Space-separated values (e.g. <js>"foo bar"</js>).
031    */
032   SSV,
033
034   /**
035    * Tab-separated values (e.g. <js>"foo\tbar"</js>).
036    */
037   TSV,
038
039   /**
040    * Pipe-separated values (e.g. <js>"foo|bar"</js>).
041    */
042   PIPES,
043
044   /**
045    * Corresponds to multiple parameter instances instead of multiple values for a single instance (e.g. <js>"foo=bar&amp;foo=baz"</js>).
046    */
047   MULTI,
048
049   /**
050    * UON collection notation (e.g. <js>"@(foo,bar)"</js>).
051    */
052   UONC,
053
054   /**
055    * Not specified.
056    */
057   NO_COLLECTION_FORMAT;
058
059   /**
060    * Create from lowercase string.
061    *
062    * @param value The enum name.
063    * @return The enum.
064    */
065   public static HttpPartCollectionFormat fromString(String value) {
066      if (value == null)
067         return null;
068      if (value.equalsIgnoreCase("UON"))
069         return UONC;
070      return valueOf(value.toUpperCase());
071   }
072
073   @Override /* Object */
074   public String toString() {
075      return name().toLowerCase();
076   }
077}