com.couchbase.lite

Class Blob

java.lang.Object

com.couchbase.lite.Blob

public final class Blob
extends Object

A Couchbase Lite Blob. A Blob appears as a property of a Document; it contains arbitrary binary data, tagged with MIME type. Blobs can be arbitrarily large, and their data is loaded only on demand (when the `content` or `contentStream` properties aar accessed), not when the document is loaded. The document's raw JSON form only contains the Blob's metadata (type, length and digest of the data) in small object. The data itself is stored externally to the document, keyed by the digest.)

Constructor Summary

Constructors

Constructor and Description
Blob(String contentType, byte[] content) Construct a Blob with the given in-memory data.
Blob(String contentType, InputStream stream) Construct a Blob with the given stream of data The blob can then be added as a property of a Document.
Blob(String contentType, URL fileURL) Construct a Blob with the content of a file.

Method Summary

Modifier and Type	Method and Description
String	digest() The cryptograhic digest of this Blob's contents, which uniquely identifies it.
void	encodeTo(FLEncoder encoder)
boolean	equals(Object o)
byte[]	getContent() Gets the contents of a Blob as a block of memory.
InputStream	getContentStream() Get the stream of content of a Blob.
String	getContentType() Return the type of content this Blob represents; by convention this is a MIME type.
Map<String,Object>	getProperties() Return the metadata associated with this Blob
int	hashCode()
long	length() The binary length of this Blob
String	toString() Returns a string representation of the object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Blob

public Blob(String contentType,
            byte[] content)

Construct a Blob with the given in-memory data. The blob can then be added as a property of a Document.

Parameters:

contentType - The type of content this Blob will represent

content - The data that this Blob will contain

Blob

public Blob(String contentType,
            InputStream stream)

Construct a Blob with the given stream of data The blob can then be added as a property of a Document.

Parameters:

contentType - The type of content this Blob will represent

stream - The stream of data that this Blob will consume

Blob

public Blob(String contentType,
            URL fileURL)
     throws IOException

Construct a Blob with the content of a file. The blob can then be added as a property of a Document.

Parameters:

contentType - The type of content this Blob will represent

fileURL - A URL to a file containing the data that this Blob will represent.

Throws:

IOException

Method Detail

getContent

public byte[] getContent()

Gets the contents of a Blob as a block of memory. Not recommended for very large blobs, as it may be slow and use up lots of RAM.

Returns:

the contents of a Blob as a block of memory

getContentStream

public InputStream getContentStream()

Get the stream of content of a Blob. The call is responsible for closing the stream when finished.

Returns:

the stream of content of a Blob

getContentType

public String getContentType()

Return the type of content this Blob represents; by convention this is a MIME type.

Returns:

the type of content

length

public long length()

The binary length of this Blob

Returns:

The binary length of this Blob

digest

public String digest()

The cryptograhic digest of this Blob's contents, which uniquely identifies it.

Returns:

The cryptograhic digest of this Blob's contents

getProperties

public Map<String,Object> getProperties()

Return the metadata associated with this Blob

Returns:

the metadata associated with this Blob

toString

public String toString()

Returns a string representation of the object.

Overrides:

toString in class Object

Returns:

a string representation of the object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

encodeTo

public void encodeTo(FLEncoder encoder)