Package com.squareup.okhttp

Class ResponseBody

java.lang.Object

com.squareup.okhttp.ResponseBody

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

RealResponseBody

public abstract class ResponseBody
extends Object
implements Closeable

Constructor Summary

Constructors

Constructor	Description
ResponseBody()

Method Summary

Modifier and Type	Method	Description
byte[]	bytes()
InputStream	byteStream()
Reader	charStream()	Returns the response as a character stream decoded with the charset of the Content-Type header.
void	close()	Closes the object and release any system resources it holds.
abstract long	contentLength()	Returns the number of bytes in that will returned by bytes(), or byteStream(), or -1 if unknown.
abstract MediaType	contentType()
static ResponseBody	create(MediaType contentType, byte[] content)	Returns a new response body that transmits content.
static ResponseBody	create(MediaType contentType, long contentLength, BufferedSource content)	Returns a new response body that transmits content.
static ResponseBody	create(MediaType contentType, String content)	Returns a new response body that transmits content.
abstract BufferedSource	source()
String	string()	Returns the response as a string decoded with the charset of the Content-Type header.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ResponseBody

public ResponseBody()

Method Detail

contentType

public abstract MediaType contentType()

contentLength

public abstract long contentLength()
                            throws IOException

Returns the number of bytes in that will returned by bytes(), or byteStream(), or -1 if unknown.

Throws:

IOException

byteStream

public final InputStream byteStream()
                             throws IOException

Throws:

IOException

source

public abstract BufferedSource source()
                               throws IOException

Throws:

IOException

bytes

public final byte[] bytes()
                   throws IOException

Throws:

IOException

charStream

public final Reader charStream()
                        throws IOException

Returns the response as a character stream decoded with the charset of the Content-Type header. If that header is either absent or lacks a charset, this will attempt to decode the response body as UTF-8.

Throws:

IOException

string

public final String string()
                    throws IOException

Returns the response as a string decoded with the charset of the Content-Type header. If that header is either absent or lacks a charset, this will attempt to decode the response body as UTF-8.

Throws:

IOException

close

public void close()
           throws IOException

Description copied from interface: Closeable

Closes the object and release any system resources it holds.

Although only the first call has any effect, it is safe to call close multiple times on the same object. This is more lenient than the overridden AutoCloseable.close(), which may be called at most once.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

create

public static ResponseBody create(MediaType contentType,
                                  String content)

Returns a new response body that transmits content. If contentType is non-null and lacks a charset, this will use UTF-8.

create

public static ResponseBody create(MediaType contentType,
                                  byte[] content)

Returns a new response body that transmits content.

create

public static ResponseBody create(MediaType contentType,
                                  long contentLength,
                                  BufferedSource content)

Returns a new response body that transmits content.