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.http;
014
015import org.apache.juneau.http.annotation.*;
016
017/**
018 * Represents a parsed <l>Transfer-Encoding</l> HTTP response header.
019 *
020 * <p>
021 * The form of encoding used to safely transfer the entity to the user.
022 * Currently defined methods are: chunked, compress, deflate, gzip, identity.
023 *
024 * <h5 class='figure'>Example</h5>
025 * <p class='bcode w800'>
026 *    Transfer-Encoding: chunked
027 * </p>
028 *
029 * <h5 class='topic'>RFC2616 Specification</h5>
030 *
031 * The Transfer-Encoding general-header field indicates what (if any) type of transformation has been applied to the
032 * message body in order to safely transfer it between the sender and the recipient.
033 * This differs from the content-coding in that the transfer-coding is a property of the message, not of the entity.
034 *
035 * <p class='bcode w800'>
036 *    Transfer-Encoding       = "Transfer-Encoding" ":" 1#transfer-coding
037 * </p>
038 *
039 * <p>
040 * Transfer-codings are defined in section 3.6. An example is:
041 *
042 * <p class='bcode w800'>
043 *    Transfer-Encoding: chunked
044 * </p>
045 *
046 * <p>
047 * If multiple encodings have been applied to an entity, the transfer-codings MUST be listed in the order in which
048 * they were applied.
049 * Additional information about the encoding parameters MAY be provided by other entity-header fields not defined by
050 * this specification.
051 *
052 * <p>
053 * Many older HTTP/1.0 applications do not understand the Transfer-Encoding header.
054 *
055 * <h5 class='section'>See Also:</h5>
056 * <ul class='doctree'>
057 *    <li class='extlink'>{@doc RFC2616}
058 * </ul>
059 */
060@Header("Transfer-Encoding")
061public final class TransferEncoding extends HeaderString {
062
063   /**
064    * Returns a parsed <code>Transfer-Encoding</code> header.
065    *
066    * @param value The <code>Transfer-Encoding</code> header string.
067    * @return The parsed <code>Transfer-Encoding</code> header, or <jk>null</jk> if the string was null.
068    */
069   public static TransferEncoding forString(String value) {
070      if (value == null)
071         return null;
072      return new TransferEncoding(value);
073   }
074
075   private TransferEncoding(String value) {
076      super(value);
077   }
078}