An entity whose content is retrieved from a file. More...
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 | |
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 |
Creates a new InputStream object of the entity. More... | |
void | writeTo (final OutputStream outstream) throws IOException |
Writes the entity content to the output stream. More... | |
boolean | isStreaming () |
Tells that this entity is not streaming. More... | |
Public Member Functions inherited from AbstractHttpEntity | |
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... | |
Additional Inherited Members | |
Protected Member Functions inherited from AbstractHttpEntity | |
AbstractHttpEntity () | |
Protected default constructor. More... | |
Protected Attributes inherited from AbstractHttpEntity | |
Header | contentType |
The Content-Type header. More... | |
Header | contentEncoding |
The Content-Encoding header. More... | |
boolean | chunked |
The 'chunked' flag. More... | |
boolean isRepeatable | ( | ) |
A repeatable entity's getContent() and writeTo(OutputStream) methods can be called more than once whereas a non-repeatable entity's can not.
Implements HttpEntity.
long getContentLength | ( | ) |
Implements HttpEntity.
InputStream getContent | ( | ) | throws IOException |
It is a programming error to return the same InputStream object more than once. Entities that are not repeatable will throw an exception if this method is called multiple times.
IOException | if the stream could not be created |
IllegalStateException | if this entity is not repeatable and the stream has already been obtained previously |
Implements HttpEntity.
void writeTo | ( | final OutputStream | outstream | ) | throws IOException |
outstream | the output stream to write entity content to |
IOException | if an I/O error occurs |
Implements HttpEntity.
boolean isStreaming | ( | ) |
false
Implements HttpEntity.