Abstract base class for entities. More...
Provides the commonly used attributes for streamed and self-contained implementations of HttpEntity .
The following notice applies to the original API on which this API is based, and to its documentation. The documentation of this API has been revised from the original.
/* * Copyright (C) 2006 The Android Open Source Project * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */
Public Member Functions | |
Header | getContentType () |
Obtains the Content-Type header. More... | |
Header | getContentEncoding () |
Obtains the Content-Encoding header. More... | |
boolean | isChunked () |
Obtains the 'chunked' flag. More... | |
void | setContentType (final Header contentType) |
Specifies the Content-Type header. More... | |
void | setContentType (final String ctString) |
Specifies the Content-Type header, as a string. More... | |
void | setContentEncoding (final Header contentEncoding) |
Specifies the Content-Encoding header. More... | |
void | setContentEncoding (final String ceString) |
Specifies the Content-Encoding header, as a string. More... | |
void | setChunked (boolean b) |
Specifies the 'chunked' flag. More... | |
void | consumeContent () throws IOException, UnsupportedOperationException |
Does not consume anything. More... | |
Public Member Functions inherited from HttpEntity | |
boolean | isRepeatable () |
Tells if the entity is capable to produce its data more than once. More... | |
long | getContentLength () |
Tells the length of the content, if known. More... | |
InputStream | getContent () throws IOException, IllegalStateException |
Creates a new InputStream object of the entity. More... | |
void | writeTo (OutputStream outstream) throws IOException |
Writes the entity content to the output stream. More... | |
boolean | isStreaming () |
Tells whether this entity depends on an underlying stream. More... | |
Protected Member Functions | |
AbstractHttpEntity () | |
Protected default constructor. More... | |
Protected Attributes | |
Header | contentType |
The Content-Type header. More... | |
Header | contentEncoding |
The Content-Encoding header. More... | |
boolean | chunked |
The 'chunked' flag. More... | |
|
protected |
The attributes of the created object remain null
and false
, respectively.
Header getContentType | ( | ) |
The default implementation returns the value of the contentType attribute.
null
Implements HttpEntity.
Header getContentEncoding | ( | ) |
The default implementation returns the value of the contentEncoding attribute.
null
Implements HttpEntity.
boolean isChunked | ( | ) |
The default implementation returns the value of the chunked attribute.
Implements HttpEntity.
void setContentType | ( | final Header | contentType | ) |
The default implementation sets the value of the contentType attribute.
contentType | the new Content-Encoding header, or null to unset |
void setContentType | ( | final String | ctString | ) |
The default implementation calls (Header) setContentType(Header) .
ctString | the new Content-Type header, or null to unset |
void setContentEncoding | ( | final Header | contentEncoding | ) |
The default implementation sets the value of the contentEncoding attribute.
contentEncoding | the new Content-Encoding header, or null to unset |
void setContentEncoding | ( | final String | ceString | ) |
The default implementation calls (Header) setContentEncoding(Header) .
ceString | the new Content-Encoding header, or null to unset |
void setChunked | ( | boolean | b | ) |
The default implementation sets the value of the chunked attribute.
b | the new 'chunked' flag |
void consumeContent | ( | ) | throws IOException, UnsupportedOperationException |
The default implementation does nothing if #isStreaming isStreaming returns false
, and throws an exception if it returns true
. This removes the burden of implementing an empty method for non-streaming entities.
IOException | in case of an I/O problem |
UnsupportedOperationException | if a streaming subclass does not override this method |
Implements HttpEntity.
Reimplemented in BasicHttpEntity, InputStreamEntity, and EntityTemplate.
|
protected |
Returned by getContentType , unless that method is overridden.
|
protected |
Returned by getContentEncoding , unless that method is overridden.
|
protected |
Returned by isChunked , unless that method is overridden.