com.google.api.client.http

Class AbstractHttpContent

java.lang.Object

com.google.api.client.http.AbstractHttpContent

All Implemented Interfaces:

HttpContent

Direct Known Subclasses:

AbstractXmlHttpContent, JsonHttpContent, MultipartRelatedContent, UrlEncodedContent

public abstract class AbstractHttpContent
extends Object
implements HttpContent

Abstract implementation of an HTTP content with typical options.

Implementation is not thread-safe.

Since:

1.5

Author:

Yaniv Inbar

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractHttpContent(HttpMediaType mediaType)
protected	AbstractHttpContent(String mediaType)

Method Summary

Methods

Modifier and Type	Method and Description
protected long	computeLength() Computes and returns the content length or less than zero if not known.
protected Charset	getCharset() Returns the charset specified in the media type or Charsets#UTF_8 if not specified.
String	getEncoding() Default implementation returns null, but subclasses may override.
long	getLength() Default implementation calls computeLength() once and caches it for future invocations, but subclasses may override.
HttpMediaType	getMediaType() Returns the media type to use for the Content-Type header, or null if unspecified.
String	getType() Returns the content type or null for none.
boolean	retrySupported() Default implementation returns true, but subclasses may override.
AbstractHttpContent	setMediaType(HttpMediaType mediaType) Sets the media type to use for the Content-Type header, or null if unspecified.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.api.client.http.HttpContent

writeTo

Constructor Detail

AbstractHttpContent

protected AbstractHttpContent(String mediaType)

Parameters:

mediaType - Media type string (for example "type/subtype") this content represents or null to leave out. Can also contain parameters like "charset=utf-8"

Since:

1.10

AbstractHttpContent

protected AbstractHttpContent(HttpMediaType mediaType)

Parameters:

mediaType - Media type this content represents or null to leave out

Since:

1.10

Method Detail

getEncoding

public String getEncoding()

Default implementation returns null, but subclasses may override.

Specified by:

getEncoding in interface HttpContent

getLength

public long getLength()
               throws IOException

Default implementation calls computeLength() once and caches it for future invocations, but subclasses may override.

Specified by:

getLength in interface HttpContent

Throws:

IOException

getMediaType

public final HttpMediaType getMediaType()

Returns the media type to use for the Content-Type header, or null if unspecified.

Since:

1.10

setMediaType

public AbstractHttpContent setMediaType(HttpMediaType mediaType)

Sets the media type to use for the Content-Type header, or null if unspecified.

This will also overwrite any previously set parameter of the media type (for example "charset"), and therefore might change other properties as well.

Since:

1.10

getCharset

protected final Charset getCharset()

Returns the charset specified in the media type or Charsets#UTF_8 if not specified.

Since:

1.10

getType

public String getType()

Description copied from interface: HttpContent

Returns the content type or null for none.

Specified by:

getType in interface HttpContent

computeLength

protected long computeLength()
                      throws IOException

Computes and returns the content length or less than zero if not known.

Subclasses may override, but by default this computes the length by calling HttpContent.writeTo(OutputStream) with an output stream that does not process the bytes written, but only retains the count of bytes. If retrySupported() is false, it will instead return -1.

Throws:

IOException

retrySupported

public boolean retrySupported()

Default implementation returns true, but subclasses may override.

Specified by:

retrySupported in interface HttpContent