com.google.api.client.http

Interface HttpContent

All Superinterfaces:

StreamingContent

All Known Implementing Classes:

AbstractHttpContent, AbstractInputStreamContent, AbstractXmlHttpContent, AtomContent, ByteArrayContent, EmptyContent, FileContent, InputStreamContent, JsonHttpContent, MockHttpContent, MultipartContent, MultipartRelatedContent, UrlEncodedContent, XmlHttpContent

public interface HttpContent
extends StreamingContent

Serializes HTTP request content into an output stream.

Implementations don't need to be thread-safe.

Since:

1.0

Author:

Yaniv Inbar

Method Summary

Methods

Modifier and Type	Method and Description
String	getEncoding() Deprecated. (scheduled to be removed in 1.15) Use HttpEncoding instead
long	getLength() Returns the content length or less than zero if not known.
String	getType() Returns the content type or null for none.
boolean	retrySupported() Returns whether or not retry is supported on this content type.
void	writeTo(OutputStream out) Writes the byte content to the given output stream.

Method Detail

getLength

long getLength()
               throws IOException

Returns the content length or less than zero if not known.

Throws:

IOException

getEncoding

@Deprecated
String getEncoding()

Deprecated. (scheduled to be removed in 1.15) Use HttpEncoding instead

Returns the content encoding (for example "gzip") or null for none.

getType

String getType()

Returns the content type or null for none.

retrySupported

boolean retrySupported()

Returns whether or not retry is supported on this content type.

Since:

1.4

writeTo

void writeTo(OutputStream out)
             throws IOException

Writes the byte content to the given output stream.

Implementations must not close the output stream, and instead should flush the output stream. Some callers may assume that the the output stream has not been closed, and will fail to work if it has been closed.

Upgrade warning: in prior version 1.13 the implementation of this method was allowed to close the stream, but starting with 1.14 closing the stream is no longer allowed.

Specified by:

writeTo in interface StreamingContent

Parameters:

out - output stream

Throws:

IOException