org.nuxeo.ecm.core.storage.binary

Class BinaryBlob

java.lang.Object

org.nuxeo.ecm.core.api.impl.blob.AbstractBlob

org.nuxeo.ecm.core.storage.binary.BinaryBlob

All Implemented Interfaces:

Serializable, Blob, ManagedBlob

public class BinaryBlob
extends AbstractBlob
implements ManagedBlob, Serializable

A Blob wrapping a Binary value.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.nuxeo.ecm.core.api.impl.blob.AbstractBlob

TEXT_PLAIN, UTF_8

Constructor Summary

Constructors

Constructor and Description
BinaryBlob(Binary binary, String filename, String mimeType, String encoding, String digest, long length)

Method Summary

Methods

Modifier and Type	Method and Description
Binary	getBinary() Gets the Binary attached to this blob.
String	getDigest()
File	getFile() If this blob is backed by an actual file, returns it.
String	getKey() Gets the stored representation of this blob.
long	getLength() Gets the data length in bytes if known.
InputStream	getStream() Gets an InputStream for the data of this blob.

Methods inherited from class org.nuxeo.ecm.core.api.impl.blob.AbstractBlob

equals, getByteArray, getCloseableFile, getCloseableFile, getEncoding, getFilename, getMimeType, getString, hashCode, setDigest, setEncoding, setFilename, setMimeType, transferTo, transferTo

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.nuxeo.ecm.core.api.Blob

getByteArray, getCloseableFile, getCloseableFile, getEncoding, getFilename, getMimeType, getString, setDigest, setEncoding, setFilename, setMimeType, transferTo, transferTo

Constructor Detail

BinaryBlob

public BinaryBlob(Binary binary,
          String filename,
          String mimeType,
          String encoding,
          String digest,
          long length)

Method Detail

getLength

public long getLength()

Description copied from interface: Blob

Gets the data length in bytes if known.

Specified by:

getLength in interface Blob

Overrides:

getLength in class AbstractBlob

Returns:

the data length or -1 if not known

getStream

public InputStream getStream()
                      throws IOException

Description copied from interface: Blob

Gets an InputStream for the data of this blob.

The contract of Blob is that this method can be called several times and will correctly return a new InputStream each time. In other words, several reads of the Blob can be done.

Like all InputStream, the result must be closed when done with it to avoid resource leaks.

Specified by:

getStream in interface Blob

Returns:

the stream

Throws:

IOException

getBinary

public Binary getBinary()

Gets the Binary attached to this blob.

Returns:

the binary

Since:

5.9.4

getDigest

public String getDigest()

Specified by:

getDigest in interface Blob

Overrides:

getDigest in class AbstractBlob

getKey

public String getKey()

Description copied from interface: ManagedBlob

Gets the stored representation of this blob.

Specified by:

getKey in interface ManagedBlob

Returns:

the stored representation

getFile

public File getFile()

Description copied from interface: Blob

If this blob is backed by an actual file, returns it.

The returned file may be short-lived (temporary), so should be used immediately.

Specified by:

getFile in interface Blob

Overrides:

getFile in class AbstractBlob

Returns:

a file, or null if the blob is not backed by a file