-
- BlackBerry Dynamics
- Runtime library for Android applications
- 12.0.1.79
Base class for wrapping entities. More...
Keeps a wrappedEntity and delegates all calls to it. Implementations of wrapping entities can derive from this class and need to override only those methods that should not be delegated to the wrapped entity.
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 | |
| HttpEntityWrapper (HttpEntity wrapped) | |
| Creates a new entity wrapper. More... | |
| boolean | isRepeatable () |
| Tells if the entity is capable to produce its data more than once. More... | |
| boolean | isChunked () |
| Tells about chunked encoding for this entity. More... | |
| long | getContentLength () |
| Tells the length of the content, if known. More... | |
| Header | getContentType () |
| Obtains the Content-Type header, if known. More... | |
| Header | getContentEncoding () |
| Obtains the Content-Encoding header, if known. More... | |
| InputStream | getContent () throws IOException |
| 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... | |
| void | consumeContent () throws IOException |
| This method is called to indicate that the content of this entity is no longer required. More... | |
Protected Attributes | |
| HttpEntity | wrappedEntity |
| The wrapped entity. More... | |
| HttpEntityWrapper | ( | HttpEntity | wrapped | ) |
| wrapped | the entity to wrap |
| 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.
Reimplemented in BufferedHttpEntity, and BasicManagedEntity.
| boolean isChunked | ( | ) |
The primary purpose of this method is to indicate whether chunked encoding should be used when the entity is sent. For entities that are received, it can also indicate whether the entity was received with chunked encoding.
The behavior of wrapping entities is implementation dependent, but should respect the primary purpose.
true if chunked encoding is preferred for this entity, or false if it is not Implements HttpEntity.
Reimplemented in BufferedHttpEntity.
| long getContentLength | ( | ) |
Implements HttpEntity.
Reimplemented in BufferedHttpEntity.
| Header getContentType | ( | ) |
This is the header that should be used when sending the entity, or the one that was received with the entity. It can include a charset attribute.
null if the content type is unknown Implements HttpEntity.
| Header getContentEncoding | ( | ) |
This is the header that should be used when sending the entity, or the one that was received with the entity. Wrapping entities that modify the content encoding should adjust this header accordingly.
null if the content encoding is unknown 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.
Reimplemented in BasicManagedEntity, and BufferedHttpEntity.
| void writeTo | ( | OutputStream | outstream | ) | throws IOException |
| outstream | the output stream to write entity content to |
| IOException | if an I/O error occurs |
Implements HttpEntity.
Reimplemented in BasicManagedEntity, and BufferedHttpEntity.
| boolean isStreaming | ( | ) |
Streamed entities should return true until the content has been consumed, false afterwards. Self-contained entities should return false. Wrapping entities should delegate this call to the wrapped entity.
The content of a streamed entity is consumed when the stream returned by getContent has been read to EOF, or after consumeContent has been called. If a streamed entity can not detect whether the stream has been read to EOF, it should return true until consumeContent is called.
true if the entity content is streamed and not yet consumed, false otherwise Implements HttpEntity.
Reimplemented in BufferedHttpEntity.
| void consumeContent | ( | ) | throws IOException |
All entity implementations are expected to release all allocated resources as a result of this method invocation. Content streaming entities are also expected to dispose of the remaining content, if any. Wrapping entities should delegate this call to the wrapped entity.
This method is of particular importance for entities being received from a connection . The entity needs to be consumed completely in order to re-use the connection with keep-alive.
| IOException | if an I/O error occurs. This indicates that connection keep-alive is not possible. |
Implements HttpEntity.
Reimplemented in BasicManagedEntity.
|
protected |