BufferedHttpEntity Class Reference

A wrapping entity that buffers it content if necessary. More...

Inheritance diagram for BufferedHttpEntity:

Description

The buffered entity is always repeatable. If the wrapped entity is repeatable itself, calls are passed through. If the wrapped entity is not repeatable, the content is read into a buffer once and provided from there as often as required.

Author

Oleg Kalnichevski

Version

Revision

496070

Since

4.0

Notice

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
long	getContentLength ()
	Tells the length of the content, if known. More...
InputStream	getContent () throws IOException
	Creates a new InputStream object of the entity. More...
boolean	isChunked ()
	Tells that this entity does not have to be chunked. More...
boolean	isRepeatable ()
	Tells that this entity is repeatable. More...
void	writeTo (final 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...
Public Member Functions inherited from HttpEntityWrapper
	HttpEntityWrapper (HttpEntity wrapped)
	Creates a new entity wrapper. More...
Header	getContentType ()
	Obtains the Content-Type header, if known. More...
Header	getContentEncoding ()
	Obtains the Content-Encoding header, if known. More...
void	consumeContent () throws IOException
	This method is called to indicate that the content of this entity is no longer required. More...

Additional Inherited Members
Protected Attributes inherited from HttpEntityWrapper
HttpEntity	wrappedEntity
	The wrapped entity. More...

Member Function Documentation

getContentLength()

long getContentLength

(

)

Returns

the number of bytes of the content, or a negative number if unknown. If the content length is known but exceeds java.lang.Long.MAX_VALUE, a negative number is returned.

Reimplemented from HttpEntityWrapper.

getContent()

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.

Returns

a new input stream that returns the entity data.

Exceptions

IOException	if the stream could not be created
IllegalStateException	if this entity is not repeatable and the stream has already been obtained previously

Reimplemented from HttpEntityWrapper.

isChunked()

boolean isChunked

(

)

Returns

false

Reimplemented from HttpEntityWrapper.

isRepeatable()

boolean isRepeatable

(

)

Returns

true

Reimplemented from HttpEntityWrapper.

writeTo()

void writeTo

(

final OutputStream

outstream

)

throws IOException

Parameters

outstream

the output stream to write entity content to

Exceptions

IOException

if an I/O error occurs

Reimplemented from HttpEntityWrapper.

isStreaming()

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.

Returns

true if the entity content is streamed and not yet consumed, false otherwise

Reimplemented from HttpEntityWrapper.