com.cloudant.sync.datastore

Class Attachment

java.lang.Object

com.cloudant.sync.datastore.Attachment

All Implemented Interfaces:

java.lang.Comparable<Attachment>

Direct Known Subclasses:

UnsavedFileAttachment, UnsavedStreamAttachment

public abstract class Attachment
extends java.lang.Object
implements java.lang.Comparable<Attachment>

Base class for Attachments

API Status: Public

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Attachment.Encoding

Field Summary

Fields

Modifier and Type	Field and Description
Attachment.Encoding	encoding Encoding - Plain or GZIP
java.lang.String	name Name of the attachment, must be unique for a given revision
java.lang.String	type MIME type of the attachment

Constructor Summary

Constructors

Constructor and Description
Attachment(java.lang.String name, java.lang.String type, Attachment.Encoding encoding)

Method Summary

Modifier and Type	Method and Description
int	compareTo(Attachment other)
static Attachment.Encoding	getEncodingFromString(java.lang.String encodingString)
abstract java.io.InputStream	getInputStream() Gets contents of attachments as a stream.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

name

public final java.lang.String name

Name of the attachment, must be unique for a given revision

type

public final java.lang.String type

MIME type of the attachment

encoding

public final Attachment.Encoding encoding

Encoding - Plain or GZIP

Constructor Detail

Attachment

public Attachment(java.lang.String name,
                  java.lang.String type,
                  Attachment.Encoding encoding)

Method Detail

getInputStream

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

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

Returns:

contents of attachments as a stream

Throws:

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

compareTo

public int compareTo(Attachment other)

Specified by:

compareTo in interface java.lang.Comparable<Attachment>

getEncodingFromString

public static Attachment.Encoding getEncodingFromString(java.lang.String encodingString)