com.google.api.client.http
Class FileContent

java.lang.Object
  com.google.api.client.http.AbstractInputStreamContent
      com.google.api.client.http.FileContent

All Implemented Interfaces:

HttpContent

public final class FileContent
extends AbstractInputStreamContent

Concrete implementation of AbstractInputStreamContent that generates repeatable input streams based on the contents of a file.

Sample use:

 
  private static void setRequestJpegContent(HttpRequest request, File jpegFile) {
    request.setContent(new FileContent("image/jpeg", jpegFile));
  }
 
 

Implementation is not thread-safe.

Since:

1.4

Author:

moshenko@google.com (Jacob Moshenko)

Constructor Summary

FileContent(String type, File file)

Method Summary

File	getFile() Returns the file.
InputStream	getInputStream() Return an input stream for the specific implementation type of AbstractInputStreamContent.
long	getLength() Returns the content length or less than zero if not known.
boolean	retrySupported() Returns whether or not retry is supported on this content type.
FileContent	setCloseInputStream(boolean closeInputStream) Sets whether the input stream should be closed at the end of AbstractInputStreamContent.writeTo(java.io.OutputStream).
FileContent	setEncoding(String encoding) Sets the content encoding (for example "gzip") or null for none.
FileContent	setType(String type) Sets the content type or null for none.

Methods inherited from class com.google.api.client.http.AbstractInputStreamContent

copy, copy, getCloseInputStream, getEncoding, getType, writeTo

Methods inherited from class java.lang.Object

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

Constructor Detail

FileContent

public FileContent(String type,
                   File file)

Parameters:

type - Content type or null for none

file - file

Since:

1.5

Method Detail

getLength

public long getLength()

Description copied from interface: HttpContent

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

retrySupported

public boolean retrySupported()

Description copied from interface: HttpContent

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

getInputStream

public InputStream getInputStream()
                           throws FileNotFoundException

Description copied from class: AbstractInputStreamContent

Return an input stream for the specific implementation type of AbstractInputStreamContent. If the specific implementation will return true for HttpContent.retrySupported() this should be a factory function which will create a new InputStream from the source data whenever invoked.

Upgrade warning: in prior version 1.6 AbstractInputStreamContent.getInputStream() was protected, it is now public.

Specified by:

getInputStream in class AbstractInputStreamContent

Throws:

FileNotFoundException

getFile

public File getFile()

Returns the file.

Since:

1.5

setEncoding

public FileContent setEncoding(String encoding)

Description copied from class: AbstractInputStreamContent

Sets the content encoding (for example "gzip") or null for none. Subclasses should override by calling super.

Overrides:

setEncoding in class AbstractInputStreamContent

setType

public FileContent setType(String type)

Description copied from class: AbstractInputStreamContent

Sets the content type or null for none. Subclasses should override by calling super.

Overrides:

setType in class AbstractInputStreamContent

setCloseInputStream

public FileContent setCloseInputStream(boolean closeInputStream)

Description copied from class: AbstractInputStreamContent

Sets whether the input stream should be closed at the end of AbstractInputStreamContent.writeTo(java.io.OutputStream). Default is true. Subclasses should override by calling super.

Overrides:

setCloseInputStream in class AbstractInputStreamContent