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 * Represents possible enum values that can be passed to the {@link HttpPartSerializerSession#serialize(HttpPartType, HttpPartSchema, Object)}.
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 HttpPartType {
023
024   /** An HTTP request body */
025   BODY,
026
027   /** A URI path variable */
028   PATH,
029
030   /** A URI query parameter */
031   QUERY,
032
033   /** A form-data parameter */
034   FORMDATA,
035
036   /** An HTTP request header */
037   HEADER,
038
039   /** An HTTP response header */
040   RESPONSE_HEADER,
041
042   /** An HTTP response body */
043   RESPONSE_BODY,
044
045   /** An HTTP response status code */
046   RESPONSE_STATUS,
047
048   /** Generic part */
049   ANY,
050
051   /** A non-standard field */
052   OTHER,
053}