com.hcl.domino.data

Interface Attachment

public interface Attachment

Attachment in a Document

Since:

0.5.0

Author:

t.b.d.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Attachment.Compression Enum for method of compression.
static interface	Attachment.IDataCallback Callback class to read the streamed attachment data

Method Summary

Modifier and Type	Method and Description
void	deleteFromDocument() Deletes an attached file item from a note and also deallocates the disk space used to store the attached file in the database.
void	extract(Path targetFilePath) Writes the attachment data to a designated path.
Attachment.Compression	getCompression() Gets the compression type for the attachment
DominoDateTime	getFileCreated() Gets the created datetime of the attachment.
DominoDateTime	getFileModified() Gets the modified datetime of the attachment
String	getFileName() Gets the filename for the attachment
long	getFileSize() Gets the filesize of the attachment
InputStream	getInputStream() Retrieves an input stream to access the data of the attachment.
Document	getParent() Returns the parent document of this attachment
void	readData(Attachment.IDataCallback callback) Method to access the binary attachment data
void	readData(Attachment.IDataCallback callback, int offset) Method to access the binary attachment data beginning at an offset in the file.

Method Detail

getFileName

String getFileName()

Gets the filename for the attachment

Returns:

filename, not null

getCompression

Attachment.Compression getCompression()

Gets the compression type for the attachment

Returns:

compression enum

getFileSize

long getFileSize()

Gets the filesize of the attachment

Returns:

filesize in bytes

getFileCreated

DominoDateTime getFileCreated()

Gets the created datetime of the attachment. TODO: Is the datetime it was attached, or the original created datetime of the file?

Returns:

datetime the file was initially created

getFileModified

DominoDateTime getFileModified()

Gets the modified datetime of the attachment

Returns:

the modified datetime of the attachment

readData

void readData(Attachment.IDataCallback callback,
              int offset)

Method to access the binary attachment data beginning at an offset in the file. The method is only supported when the attachment has no compression. Otherwise we will throw an UnsupportedOperationException.

Parameters:

callback - callback is called with streamed data

offset - offset to start reading

readData

void readData(Attachment.IDataCallback callback)

Method to access the binary attachment data

Parameters:

callback - callback is called with streamed data

deleteFromDocument

void deleteFromDocument()

Deletes an attached file item from a note and also deallocates the disk space used to store the attached file in the database.

getParent

Document getParent()

Returns the parent document of this attachment

Returns:

document

extract

void extract(Path targetFilePath)
      throws IOException

Writes the attachment data to a designated path.

Implementation note: using a local filesystem path is more efficient than using a path from an abstracted provider.

Parameters:

targetFilePath - the file path of the file to write

Throws:

IOException - in case of I/O errors

getInputStream

InputStream getInputStream()
                    throws IOException

Retrieves an input stream to access the data of the attachment.

Returns:

a new InputStream for the attachment data

Throws:

IOException - in case of I/O errors