The Tor Browser / annotate

mobile/android/thirdparty/ch/boye/httpclientandroidlib/entity/AbstractHttpEntity.java@6474c204b198 (annotated)

mobile/android/thirdparty/ch/boye/httpclientandroidlib/entity/AbstractHttpEntity.java

Wed, 31 Dec 2014 06:09:35 +0100

author
Michael Schloh von Bennewitz <michael@schloh.com>
date
Wed, 31 Dec 2014 06:09:35 +0100
changeset 0
6474c204b198
permissions
-rw-r--r--

Cloned upstream origin tor-browser at tor-browser-31.3.0esr-4.5-1-build1
revision ID fc1c9ff7c1b2defdbc039f12214767608f46423f for hacking purpose.

michael@0 1 /*
michael@0 2 * ====================================================================
michael@0 3 * Licensed to the Apache Software Foundation (ASF) under one
michael@0 4 * or more contributor license agreements. See the NOTICE file
michael@0 5 * distributed with this work for additional information
michael@0 6 * regarding copyright ownership. The ASF licenses this file
michael@0 7 * to you under the Apache License, Version 2.0 (the
michael@0 8 * "License"); you may not use this file except in compliance
michael@0 9 * with the License. You may obtain a copy of the License at
michael@0 10 *
michael@0 11 * http://www.apache.org/licenses/LICENSE-2.0
michael@0 12 *
michael@0 13 * Unless required by applicable law or agreed to in writing,
michael@0 14 * software distributed under the License is distributed on an
michael@0 15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
michael@0 16 * KIND, either express or implied. See the License for the
michael@0 17 * specific language governing permissions and limitations
michael@0 18 * under the License.
michael@0 19 * ====================================================================
michael@0 20 *
michael@0 21 * This software consists of voluntary contributions made by many
michael@0 22 * individuals on behalf of the Apache Software Foundation. For more
michael@0 23 * information on the Apache Software Foundation, please see
michael@0 24 * <http://www.apache.org/>.
michael@0 25 *
michael@0 26 */
michael@0 27
michael@0 28 package ch.boye.httpclientandroidlib.entity;
michael@0 29
michael@0 30 import java.io.IOException;
michael@0 31 import java.io.OutputStream;
michael@0 32
michael@0 33 import ch.boye.httpclientandroidlib.Header;
michael@0 34 import ch.boye.httpclientandroidlib.HttpEntity;
michael@0 35 import ch.boye.httpclientandroidlib.message.BasicHeader;
michael@0 36 import ch.boye.httpclientandroidlib.protocol.HTTP;
michael@0 37
michael@0 38 /**
michael@0 39 * Abstract base class for entities.
michael@0 40 * Provides the commonly used attributes for streamed and self-contained
michael@0 41 * implementations of {@link HttpEntity HttpEntity}.
michael@0 42 *
michael@0 43 * @since 4.0
michael@0 44 */
michael@0 45 public abstract class AbstractHttpEntity implements HttpEntity {
michael@0 46
michael@0 47 protected Header contentType;
michael@0 48 protected Header contentEncoding;
michael@0 49 protected boolean chunked;
michael@0 50
michael@0 51 /**
michael@0 52 * Protected default constructor.
michael@0 53 * The contentType, contentEncoding and chunked attributes of the created object are set to
michael@0 54 * <code>null</code>, <code>null</code> and <code>false</code>, respectively.
michael@0 55 */
michael@0 56 protected AbstractHttpEntity() {
michael@0 57 super();
michael@0 58 }
michael@0 59
michael@0 60
michael@0 61 /**
michael@0 62 * Obtains the Content-Type header.
michael@0 63 * The default implementation returns the value of the
michael@0 64 * {@link #contentType contentType} attribute.
michael@0 65 *
michael@0 66 * @return the Content-Type header, or <code>null</code>
michael@0 67 */
michael@0 68 public Header getContentType() {
michael@0 69 return this.contentType;
michael@0 70 }
michael@0 71
michael@0 72
michael@0 73 /**
michael@0 74 * Obtains the Content-Encoding header.
michael@0 75 * The default implementation returns the value of the
michael@0 76 * {@link #contentEncoding contentEncoding} attribute.
michael@0 77 *
michael@0 78 * @return the Content-Encoding header, or <code>null</code>
michael@0 79 */
michael@0 80 public Header getContentEncoding() {
michael@0 81 return this.contentEncoding;
michael@0 82 }
michael@0 83
michael@0 84 /**
michael@0 85 * Obtains the 'chunked' flag.
michael@0 86 * The default implementation returns the value of the
michael@0 87 * {@link #chunked chunked} attribute.
michael@0 88 *
michael@0 89 * @return the 'chunked' flag
michael@0 90 */
michael@0 91 public boolean isChunked() {
michael@0 92 return this.chunked;
michael@0 93 }
michael@0 94
michael@0 95
michael@0 96 /**
michael@0 97 * Specifies the Content-Type header.
michael@0 98 * The default implementation sets the value of the
michael@0 99 * {@link #contentType contentType} attribute.
michael@0 100 *
michael@0 101 * @param contentType the new Content-Encoding header, or
michael@0 102 * <code>null</code> to unset
michael@0 103 */
michael@0 104 public void setContentType(final Header contentType) {
michael@0 105 this.contentType = contentType;
michael@0 106 }
michael@0 107
michael@0 108 /**
michael@0 109 * Specifies the Content-Type header, as a string.
michael@0 110 * The default implementation calls
michael@0 111 * {@link #setContentType(Header) setContentType(Header)}.
michael@0 112 *
michael@0 113 * @param ctString the new Content-Type header, or
michael@0 114 * <code>null</code> to unset
michael@0 115 */
michael@0 116 public void setContentType(final String ctString) {
michael@0 117 Header h = null;
michael@0 118 if (ctString != null) {
michael@0 119 h = new BasicHeader(HTTP.CONTENT_TYPE, ctString);
michael@0 120 }
michael@0 121 setContentType(h);
michael@0 122 }
michael@0 123
michael@0 124
michael@0 125 /**
michael@0 126 * Specifies the Content-Encoding header.
michael@0 127 * The default implementation sets the value of the
michael@0 128 * {@link #contentEncoding contentEncoding} attribute.
michael@0 129 *
michael@0 130 * @param contentEncoding the new Content-Encoding header, or
michael@0 131 * <code>null</code> to unset
michael@0 132 */
michael@0 133 public void setContentEncoding(final Header contentEncoding) {
michael@0 134 this.contentEncoding = contentEncoding;
michael@0 135 }
michael@0 136
michael@0 137 /**
michael@0 138 * Specifies the Content-Encoding header, as a string.
michael@0 139 * The default implementation calls
michael@0 140 * {@link #setContentEncoding(Header) setContentEncoding(Header)}.
michael@0 141 *
michael@0 142 * @param ceString the new Content-Encoding header, or
michael@0 143 * <code>null</code> to unset
michael@0 144 */
michael@0 145 public void setContentEncoding(final String ceString) {
michael@0 146 Header h = null;
michael@0 147 if (ceString != null) {
michael@0 148 h = new BasicHeader(HTTP.CONTENT_ENCODING, ceString);
michael@0 149 }
michael@0 150 setContentEncoding(h);
michael@0 151 }
michael@0 152
michael@0 153
michael@0 154 /**
michael@0 155 * Specifies the 'chunked' flag.
michael@0 156 * <p>
michael@0 157 * Note that the chunked setting is a hint only.
michael@0 158 * If using HTTP/1.0, chunking is never performed.
michael@0 159 * Otherwise, even if chunked is false, HttpClient must
michael@0 160 * use chunk coding if the entity content length is
michael@0 161 * unknown (-1).
michael@0 162 * <p>
michael@0 163 * The default implementation sets the value of the
michael@0 164 * {@link #chunked chunked} attribute.
michael@0 165 *
michael@0 166 * @param b the new 'chunked' flag
michael@0 167 */
michael@0 168 public void setChunked(boolean b) {
michael@0 169 this.chunked = b;
michael@0 170 }
michael@0 171
michael@0 172
michael@0 173 /**
michael@0 174 * The default implementation does not consume anything.
michael@0 175 *
michael@0 176 * @deprecated Either use {@link #getContent()} and call {@link java.io.InputStream#close()} on that;
michael@0 177 * otherwise call {@link #writeTo(OutputStream)} which is required to free the resources.
michael@0 178 */
michael@0 179 public void consumeContent() throws IOException {
michael@0 180 }
michael@0 181
michael@0 182 }

Mercurial Repository: The Tor Browser

Europalab SCM Repository Server

mercurial