com.cloudant.sync.datastore

Class UnsavedFileAttachment

java.lang.Object

com.cloudant.sync.datastore.Attachment

com.cloudant.sync.datastore.UnsavedFileAttachment

All Implemented Interfaces:

java.lang.Comparable<Attachment>

public class UnsavedFileAttachment
extends Attachment

An Attachment which has been prepared by the user for saving to the database

API Status: Public

Nested Class Summary

Nested classes/interfaces inherited from class com.cloudant.sync.datastore.Attachment

Attachment.Encoding

Field Summary

Fields inherited from class com.cloudant.sync.datastore.Attachment

encoding, name, type

Constructor Summary

Constructors

Constructor and Description
UnsavedFileAttachment(java.io.File file, java.lang.String type)
UnsavedFileAttachment(java.io.File file, java.lang.String type, Attachment.Encoding encoding)

Method Summary

Modifier and Type	Method and Description
java.io.InputStream	getInputStream() Gets contents of attachments as a stream.

Methods inherited from class com.cloudant.sync.datastore.Attachment

compareTo, getEncodingFromString, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

UnsavedFileAttachment

public UnsavedFileAttachment(java.io.File file,
                             java.lang.String type)

UnsavedFileAttachment

public UnsavedFileAttachment(java.io.File file,
                             java.lang.String type,
                             Attachment.Encoding encoding)

Method Detail

getInputStream

public java.io.InputStream getInputStream()
                                   throws java.io.IOException

Description copied from class: Attachment

Gets contents of attachments as a stream. Caller must call close() when done.

Specified by:

getInputStream in class Attachment

Returns:

contents of attachments as a stream

Throws:

java.io.IOException - there was an error obtaining the stream, eg from disk or network