com.cloudant.sync.datastore

Class SavedHttpAttachment

java.lang.Object

com.cloudant.sync.datastore.Attachment

com.cloudant.sync.datastore.SavedHttpAttachment

All Implemented Interfaces:

java.lang.Comparable<Attachment>

public class SavedHttpAttachment
extends Attachment

Created by rhys on 20/11/14.

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
SavedHttpAttachment(java.lang.String name, java.util.Map<java.lang.String,java.lang.Object> attachmentData, java.net.URI attachmentURI) Creates a SavedHttpAttachment (a fully initialised attachment) with the provided properties

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

SavedHttpAttachment

public SavedHttpAttachment(java.lang.String name,
                           java.util.Map<java.lang.String,java.lang.Object> attachmentData,
                           java.net.URI attachmentURI)
                    throws java.io.IOException

Creates a SavedHttpAttachment (a fully initialised attachment) with the provided properties

Parameters:

name - The name of the attachment eg bonsai-boston.jpg

attachmentData - The json attachment data from a couchDB instance

attachmentURI - The URI at which the attachment can be downloaded

Throws:

java.io.IOException - if there is an error decoding the attachment data

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